Prefer force_registration=true in Config documentation #6259
Conversation
This file contains 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
Jackenmen
added
the
Type: Enhancement
github-actions
bot
added
Category: Core - API - Config
Flame442
requested changes
Nov 6, 2023
| @@ -304,7 +305,7 @@ the built-in Economy credits:: | |||
|
|
|||
| class Pets(commands.Cog): | |||
| def __init__(self): | |||
| self.config = Config.get_conf(self, 1234567890) | |||
| self.config = Config.get_conf(self, 1234567890, force_registration=True) | |||
There was a problem hiding this comment.
Should this use identifier as a kwarg, to match other examples?
There was a problem hiding this comment.
Variety in examples shows that there are multiple valid ways of using the method - seems fine to me.
Co-authored-by: Michael Oliveira <34169552+Flame442@users.noreply.github.com>
Flame442
approved these changes
Nov 6, 2023
red-githubbot
bot
added
the
Changelog Entry: Pending
Jackenmen
added
Changelog Entry: Added
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the changes
Adds
force_registration=Trueto allConfig.get_conf()usage examples with the exception of "V2 Data Usage" section where no defaults are registered and this may be unwanted.Additionally, I did a slight rephrasing and clarification to the documentation that mentions
force_registration=True.Have the changes in this PR been tested?
Yes