Show visibility of properties in API docs (i.e. protected v. public)
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
In the old docs, we showed when properties/methods are protected v. public. Ideally we should do this in our current API docs as well. Note, most of the API on LitElement/ReactiveElement is protected.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the old API documentation with the current API docs, using the linked LitElement requestUpdateInternal example as the starting point. Identify how the current docs represent properties and methods, then update the documentation generation or presentation so protected and public visibility is shown consistently; done means the API pages display these distinctions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100