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

Annotate inherited methods #598

Open
Chriscbr opened this issue Feb 8, 2022 · 3 comments
Open

Annotate inherited methods #598

Chriscbr opened this issue Feb 8, 2022 · 3 comments

Comments

@Chriscbr
Copy link
Contributor

Chriscbr commented Feb 8, 2022

It may be useful to the reader of an API reference if it showed which methods were inherited from a superclass (and perhaps even which class it was inherited from?)

This might require augmenting the JSON schema for methods / callables with an additional field containing inheritance information.

@vgkowski
Copy link
Contributor

I would add the requirement to mask some inherited methods like the ones inherited from Construct toString or isConstruct for example. The idea is to minimize the size of the API reference.

@Chriscbr
Copy link
Contributor Author

Good idea. Every construct in the Constructs section of the generated docs by definition inherits from Construct so those methods are pretty superfluous.

@Chriscbr Chriscbr removed the backlog label Mar 21, 2022
@riywo
Copy link

riywo commented Nov 29, 2022

Does anyone have a workaround except modifying API.md every time...?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants