Skip to content

Conversation

@obozdag
Copy link
Contributor

@obozdag obozdag commented Apr 24, 2024

Description
Some typos in database/configuration.rst

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Some typos in database/configuration.rst
@kenjis kenjis added the documentation Pull requests for documentation only label Apr 25, 2024
Change path for SQLite3 sample in configuration.rst
Copy link
Member

@kenjis kenjis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

.. 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

.. 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@kenjis kenjis Apr 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about adding description that the default value for the parameter is true?

obozdag and others added 8 commits April 26, 2024 07:23
…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
Fix getresult link in database/query_builder.rst
@kenjis kenjis merged commit 7dfd334 into codeigniter4:develop Apr 30, 2024
@obozdag obozdag deleted the patch-2 branch May 3, 2024 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants