docs: Some typos in database/configuration.rst #8825
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some typos in database/configuration.rst
kenjis
reviewed
Apr 25, 2024
Change path for SQLite3 sample in configuration.rst
datamweb
approved these changes
Apr 25, 2024
Some typo in database/query_builder.rst
kenjis
reviewed
Apr 25, 2024
| @@ -88,7 +88,7 @@ $query, which can be used to show the results: | |||
|
|
|||
| .. literalinclude:: query_builder/004.php | |||
|
|
|||
| Please visit the :doc:`getResult*() method <results>` page for a full | |||
| Please visit the :doc:`getResult() method <results>` page for a full | |||
There was a problem hiding this comment.
I agree to remove *. The * implies getResultArray() and getCustomResultObject(), but they are referred in the getResult() section.
But it is better that the destination is getResult(), not the page.
Can you change the destination?
See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/documentation.rst#to-a-section
kenjis
reviewed
Apr 26, 2024
| @@ -101,14 +101,14 @@ Example: | |||
|
|
|||
| .. literalinclude:: query_builder/005.php | |||
|
|
|||
| The first parameter enables you to set whether or not the query builder query | |||
| The parameter in the first query (false) enables you to set whether or not the query builder | |||
There was a problem hiding this comment.
I don't get what "the first query" is.
It means "the first parameter of the getCompiledSelect() method".
So "The first parameter" is correct and no problem.
There was a problem hiding this comment.
How about adding description that the default value for the parameter is true?
…ry_builder.rst Added getCompiledSelect method parameter's default value explanation in query_builder.rst
Added link to getResult() method in results.rst
Update link to getResult() method in query_builder.rst
Correct getresult link in query_builder.rst
Change Query Helper Functions to Methods in database/index.rst
…s.rst Change backwards to backward for consistency in database/results.rst
Delete unnecessary "Example:" in database/helpers.rst
kenjis
reviewed
Apr 27, 2024
Fix getresult link in database/query_builder.rst
kenjis
approved these changes
Apr 27, 2024
michalsn
approved these changes
Apr 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Some typos in database/configuration.rst
Checklist: