Skip to content
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

feat: Document overriden/inherited members #238

Merged
merged 3 commits into from
Sep 19, 2018

Conversation

RomainMuller
Copy link
Contributor

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

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
@@ -196,3 +196,10 @@ BaseProps (interface)
:type: string *(abstract)*


.. py:attribute:: foo

*Inherited from* :py:attr:`@scope/jsii-calc-base-of-base.VeryBaseProps.foo`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not more correct to say "inherited from " instead of "inherited from " ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But... but they're the same string...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@RomainMuller RomainMuller merged commit 7a6278a into master Sep 19, 2018
@RomainMuller RomainMuller deleted the rmuller/document-inherited branch September 19, 2018 13:52
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants