-
-
Notifications
You must be signed in to change notification settings - Fork 402
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
config.types: doc ALL the things! #1719
Merged
Merged
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
dgw
referenced
this pull request
Oct 22, 2019
You can't get the docstring of an attribute, sadly. Close #864
Exirel
requested changes
Oct 23, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have fun!
26 tasks
dgw
commented
Oct 23, 2019
dgw
commented
Oct 23, 2019
Exirel
approved these changes
Oct 23, 2019
There's a lot to parse (ha!) here, but most of it is pretty obvious in purpose. The one thing I think I should explain is why all the `parse()` and `serialize()` instances have their own docstrings now. It's because I was having fun! Just kidding (sort of). It's actually because Sphinx autodoc pulls the docstring from the parent class's method if a subclass's overriding method doesn't have a docstring of its own. In hindsight, writing new docstrings might have been *more* work than the alternative (setting `autodoc_inherit_docstrings = False` in `docs/conf.py` and checking to see if anything broke), but what's done is done at this point. We can still change the setting later. Co-Authored-By: Exirel <florian.strzelecki@gmail.com>
c916d0e
to
4f173c0
Compare
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.
There's a lot to parse (ha!) here, but most of it is pretty obvious in purpose. The one thing I think I should explain is why all the
parse()
andserialize()
instances have their own docstrings now.It's because I was having fun! Just kidding (sort of). It's actually because Sphinx autodoc pulls the docstring from the parent class's method if a subclass's overriding method doesn't have a docstring of its own. In hindsight, writing new docstrings might have been more work than the alternative (setting
autodoc_inherit_docstrings = False
indocs/conf.py
and checking to see if anything broke), but what's done is done at this point. We can still change the setting later.Also of note: I removed a reference to some feature of
StaticSection.configure_setting()
that never worked (havingprompt
be an optional argument). See #864 & ab83a1f.This set of documentation updates was extracted from the remains of #1689 after development took a different direction for handling
#
in multi-lineListAttribute
config values. I think I removed all the references to stuff that doesn't apply without its former parent commit from that PR… Dear reviewer(s): please double-check to make sure I didn't miss anything else! ❤️