Documentation doesn't mention inherited members #196
Assignees
Labels
feature-request
A feature should be added or improved.
Comments
|
I agree, we should include the full docs for inherited members! |
|
Does that mean we'll also show all Construct members for all that extend Construct, such as BucketRef? |
|
Yes, ideally indicating where these methods came from... |
RomainMuller
added a commit
that referenced
this issue
Sep 18, 2018
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
RomainMuller
added a commit
that referenced
this issue
Sep 19, 2018
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
eladb
pushed a commit
that referenced
this issue
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)
srchase
added
feature-request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The documentation generated by
jsii-pacmakdoes not include references to inherited members that were not overridden. This makes the documentation appear a little confusing and makes discovery of a full API surface more complicated.For example, the
s3.Bucketclass inherits most of it's interesting members froms3.BucketRef, but this is not entirely obvious (particularly to a newcomer). The documentation should include inherited members as part of a class' documentation in one way or another.The text was updated successfully, but these errors were encountered: