docs: Some typos in database/configuration.rst by obozdag · Pull Request #8825 · codeigniter4/CodeIgniter4

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

obozdag · 2024-04-24T04:38:24Z

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

Change path for SQLite3 sample in configuration.rst

kenjis

LGTM!

Some typo in database/query_builder.rst

kenjis · 2024-04-25T23:56:16Z

 .. 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


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 · 2024-04-26T00:02:55Z

 .. 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


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.

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

Fix getresult link in database/query_builder.rst

docs: Some typos in database/configuration.rst
c99d089
Some typos in database/configuration.rst

kenjis added the documentation Pull requests for documentation only label Apr 25, 2024

kenjis reviewed Apr 25, 2024
View reviewed changes

Comment threaduser_guide_src/source/database/configuration.rst Outdated

docs: Change path for SQLite3 sample in configuration.rst
9333516
Change path for SQLite3 sample in configuration.rst

kenjis approved these changes Apr 25, 2024
View reviewed changes

datamweb approved these changes Apr 25, 2024
View reviewed changes

obozdagand others added 2 commits April 25, 2024 17:10

docs: Some typo in database/query_builder.rst
84fa8f0
Some typo in database/query_builder.rst

Merge branch 'codeigniter4:develop' into patch-2
7737800

kenjis reviewed Apr 25, 2024
View reviewed changes

kenjis reviewed Apr 26, 2024
View reviewed changes

obozdagand others added 8 commits April 26, 2024 07:23

docs: Added getCompiledSelect method parameter's default value in que…
e49aa37
…ry_builder.rst Added getCompiledSelect method parameter's default value explanation in query_builder.rst

docs: Added link to getResult() method in results.rst
6abf095
Added link to getResult() method in results.rst

docs: Update link to getResult() method in query_builder.rst
28d9a43
Update link to getResult() method in query_builder.rst

Merge branch 'codeigniter4:develop' into patch-2
1e6cde3

docs: Correct getresult link in query_builder.rst
9a05a16
Correct getresult link in query_builder.rst

docs: Change Query Helper Functions to Methods in database/index.rst
5d09e42
Change Query Helper Functions to Methods in database/index.rst

docs: Change backwards to backward for consistency in database/result…
3529d62
…s.rst Change backwards to backward for consistency in database/results.rst

docs: Delete unnecessary "Example:" in database/helpers.rst
1fc8af9
Delete unnecessary "Example:" in database/helpers.rst

kenjis reviewed Apr 27, 2024
View reviewed changes

Comment threaduser_guide_src/source/database/query_builder.rst Outdated

docs: Fix getresult link in database/query_builder.rst
c12915e
Fix getresult link in database/query_builder.rst

kenjis approved these changes Apr 27, 2024
View reviewed changes

michalsn approved these changes Apr 29, 2024
View reviewed changes

kenjis merged commit 7dfd334 into codeigniter4:developApr 30, 2024

obozdag deleted the patch-2 branch May 3, 2024 04:26