Remove the (!) from Seeder Storage documentation, and explicitly document any meaning that was intended by it #13279
Labels
stale
type: docs
For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.
Issue Description
What was unclear/insufficient/not covered in the documentation
The seeder documentation is very helpful, but has what I interpret as a "scare exclamation mark" in the documentation on changing the storage location of seeders. In the "Seed Storage" section:
To me this implies that I should be cautious about changing this behavior, or that it is discouraged, but the rest of the docs have no explanation of why this might be, or what the pitfalls of changing this are. In contrast, the "Migrations Storage" section does have an explicit note about why "none" is not recommended.
If possible: Provide some suggestion on how we can enhance the docs
In any case, the exclamation mark should be removed, it serves only to sow uncertainty and confusion. If there are undocumented pitfalls, they should be noted explicitly (similar to the note about why "none" is not recommended for migrations) instead.
Additional context
This exclamation point has been around since this documentation was introduced in #8319, so I couldn't gain any insight about why it is there.
Issue Template Checklist
Is this issue dialect-specific?
Would you be willing to resolve this issue by submitting a Pull Request?
(Ed: The PR is pretty incidental, what I'm missing is the knowledge of why the exclamation mark is there in the first place, and what it's trying to communicate)
The text was updated successfully, but these errors were encountered: