-
Notifications
You must be signed in to change notification settings - Fork 824
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC Document correct method signature for DB::require_table #11425
base: 5
Are you sure you want to change the base?
DOC Document correct method signature for DB::require_table #11425
Conversation
src/ORM/DB.php
Outdated
* @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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, looks like you put the null in the wrong place.
21e71ce
to
9b8169f
Compare
* @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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @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? |
The method signature for
DB::require_table
is wrong and should match the one fromDBSchemaManager::requireTable
.I've documented the return type for both method while I was in there.
Parent issue