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

[Bug] Protected properties are included in args table #21

Closed
Yogu opened this issue May 23, 2022 · 1 comment · Fixed by #28
Closed

[Bug] Protected properties are included in args table #21

Yogu opened this issue May 23, 2022 · 1 comment · Fixed by #28
Assignees
Labels
bug Something isn't working

Comments

@Yogu
Copy link

Yogu commented May 23, 2022

The args table currently includes protected properties of components without indicating that they are protected.

I guess in most cases, protected properties do not need to be shown at all. In an API documentation, they are only relevant for classes that are intended to be subclassed. In other cases, protected members usually are an artifact of how a component is implemented instead of part of the API.

The angular framework itself excludes protected members from the public API except for classes that are explicitly marked as non-final in the documentation.

@Yogu Yogu added the bug Something isn't working label May 23, 2022
@Etienne-Buschong
Copy link
Collaborator

Yes, the plan was to exclude protected and private properties and i simply overlooked the protected properties.
Since the target audience of the generated types are developers consuming public components, and not extending them, i think it is fine to always exclude protected properties.

@Etienne-Buschong Etienne-Buschong self-assigned this May 31, 2022
@Etienne-Buschong Etienne-Buschong linked a pull request Jun 7, 2022 that will close this issue
@Etienne-Buschong Etienne-Buschong removed a link to a pull request Jun 9, 2022
@Etienne-Buschong Etienne-Buschong linked a pull request Jun 9, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants