Document the config API #6384
Merged
Document the config API #6384
Conversation
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
Coverage Results ✅ |
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.
This adds a section on the config API to the internal API docs section. For the docs, most of this is delegated to
autodoc, but that highlighted that many of the methods on theFluffConfigobject were pretty poorly documented, so the bulk of this PR is additional docstrings for those methods.In the process, there's a little bit of improved typing in a few of the methods, with few knock-on effects in the dict helpers and a few other places. That includes cutting back some of the available options on some of the
classmethodsforFluffConfig, which either weren't used, or didn't make much sense.I think this resolves #6038 and resolves #5061 too.