DOC Document correct method signature for DB::require_table #11425
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
2 tasks
GuySartorelli
requested changes
Oct 21, 2024
src/ORM/DB.php
Outdated
Comment on lines
553
to
554
| * @param array $fieldSchema A list of the fields to create, in the same form as DataObject::$db | ||
| * @param array $indexSchema A list of indexes to create. See {@link requireIndex()} |
There was a problem hiding this comment.
Suggested change
| * @param array $fieldSchema A list of the fields to create, in the same form as DataObject::$db | |
| * @param array $indexSchema A list of indexes to create. See {@link requireIndex()} | |
| * @param array|null $fieldSchema A list of the fields to create, in the same form as DataObject::$db | |
| * @param array|null $indexSchema A list of indexes to create. See {@link requireIndex()} |
null is the default value for these parameters
There was a problem hiding this comment.
Oops, looks like you put the null in the wrong place.
maxime-rainville
force-pushed
the
pull/5/doc-db-require-table-signature
branch
from
21e71ce
to
9b8169f
Compare
GuySartorelli
requested changes
Oct 23, 2024
Comment on lines
+553
to
+554
| * @param array $fieldSchema|null A list of the fields to create, in the same form as DataObject::$db | ||
| * @param array $indexSchema|null A list of indexes to create. See {@link require_index()} |
There was a problem hiding this comment.
Suggested change
| * @param array $fieldSchema|null A list of the fields to create, in the same form as DataObject::$db | |
| * @param array $indexSchema|null A list of indexes to create. See {@link require_index()} | |
| * @param array|null $fieldSchema A list of the fields to create, in the same form as DataObject::$db | |
| * @param array|null $indexSchema A list of indexes to create. See {@link require_index()} |
|
@maxime-rainville Do you think you'll have a chance to resolve the outstanding requested changes? |
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.
The method signature for
DB::require_tableis wrong and should match the one fromDBSchemaManager::requireTable.I've documented the return type for both method while I was in there.
Parent issue