Update the autodoc directive to improve overloaded functions #160
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
Joseph-Edwards
force-pushed
the
directive
branch
from
f854f80 to
8db880a
Compare
|
I've just noticed a few problems with this, specifically with |
|
@Joseph-Edwards looks good, but needs to be rebased please |
james-d-mitchell
added
documentation
Joseph-Edwards
force-pushed
the
directive
branch
from
8db880a to
ad248ee
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.
This PR improves how overloaded functions get rendered in the documentation. Specifically, it formats them in the same that non-overloaded functions get formatted, and adds a level of indentation.
I decided to use this directive to override the standard
autoclassandautofunctiondirectives, since it provides a superset of their functionality. The only downside that I can see is that this causes adirective already registeredwarning. If this is undesirable I can call it something else.