Skip to content

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

Merged
kenjis merged 2 commits intocodeigniter4:developfrom
kenjis:docs-db-migration
Nov 22, 2023
Merged

docs: [Migration] clarify that $db is for testing purposes#8222
kenjis merged 2 commits intocodeigniter4:developfrom
kenjis:docs-db-migration

Conversation

@kenjis
Copy link
Copy Markdown
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
@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
Copy Markdown
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