docs: note required:true settings need a default or host null-fills#4
Merged
Conversation
Follow-up to phlix-server #329 which fixed PluginLoader::defaultSettings() to null-fill required:true settings that lack a default. Document this behavior in the plugin example README under 'Fork as a starter'.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Up to standards ✅🟢 Issues
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Follow-up to phlix-server #329 which fixed
PluginLoader::defaultSettings()to null-fillrequired:truesettings that lack a default. This PR documents that behavior in the plugin example README under 'Fork as a starter', step 2 (plugin.json editing).Changes
README.md: Added note: "If you declare a settingrequired:true, give it adefaultor the host will null-fill it — see manifest docs."Gate
composer validate: PASSvendor/bin/phpunit --colors=always: PASS (4 tests, 4 assertions)