Skip to content
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

docs: [Migration] clarify that $db is for testing purposes #8222

Merged
merged 2 commits into from
Nov 22, 2023

Conversation

kenjis
Copy link
Member

@kenjis kenjis commented Nov 15, 2023

Description
Related #8221

  • clarify that $db is for testing purposes

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

@kenjis kenjis merged commit 5412fe4 into codeigniter4:develop Nov 22, 2023
62 checks passed
@kenjis kenjis deleted the docs-db-migration branch November 22, 2023 00:01
* - array of database configuration values
*
* @param array|ConnectionInterface|string|null $db
* @param array|ConnectionInterface|string|null $db DB group. For testing purposes only.
Copy link
Member

Choose a reason for hiding this comment

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

Interesting that @internal can be used inline: https://docs.phpdoc.org/2.9/references/phpdoc/inline-tags/internal.html

I wonder if any static analyzers would enforce this on a parameter?

Suggested change
* @param array|ConnectionInterface|string|null $db DB group. For testing purposes only.
* @param array|ConnectionInterface|string|null $db DB group. {@internal For testing purposes only.}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants