feat: Document overriden/inherited members #238
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
Add a documentation line outlining the parent declaration of overridden members as well as inherited members that are not overridden locally. This should make browsing the documentation a lot nicer. Inherited and overridden statements in the documentation always refer to the fully qualified name of the super statement. Fixes #196
rix0rrr
reviewed
Sep 18, 2018
| @@ -196,3 +196,10 @@ BaseProps (interface) | |||
| :type: string *(abstract)* | |||
|
|
|||
|
|
|||
| .. py:attribute:: foo | |||
|
|
|||
| *Inherited from* :py:attr:`@scope/jsii-calc-base-of-base.VeryBaseProps.foo` | |||
There was a problem hiding this comment.
Is it not more correct to say "inherited from " instead of "inherited from " ?
There was a problem hiding this comment.
But... but they're the same string...
There was a problem hiding this comment.
Oh well. I wrote something between < and > but got eaten by the MarkDown rendered. Shoulda guessed.
I meant to say, "inherited from $CLASS" seems more correct than "inherited from $METHOD".
Fuuuuu--- that gif is distracting!
There was a problem hiding this comment.
That's what I kinda guessed when I saw your first comment. I wanted the link to be to the parent class' method/property, and not to the class itself... But what I can do is set a custom label on the link, so it'll be the best of both.
rix0rrr
approved these changes
Sep 18, 2018
eladb
pushed a commit
that referenced
this pull request
Sep 20, 2018
Bug Fixes ====================== * Sphinx generated incorrect type references for display ([#232](#232)) ([b664805](b664805)) * **jsii:** Defaulted parameters were not rendered as optional ([#234](#234)) ([578bf9c](578bf9c)), closes [#233](#233) * **jsii:** Don't skip emit on TS errors when in "watch" mode ([#236](#236)) ([30d1491](30d1491)), closes [#235](#235) * **jsii:** Optional `any` represented as required ([#237](#237)) ([91074f3](91074f3)), closes [#230](#230) Features ====================== * **sphinx:** allow readme file to define sphinx header and reorganize topic ([#229](#229)) ([405da9c](405da9c)), closes [#228](#228) [#185](#185) * Document overriden/inherited members ([#238](#238)) ([7a6278a](7a6278a)), closes [#196](#196)
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.
Add a documentation line outlining the parent declaration of overridden
members as well as inherited members that are not overridden locally.
This should make browsing the documentation a lot nicer.
Inherited and overridden statements in the documentation always refer to
the fully qualified name of the super statement.
Fixes #196