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.

Sign up for GitHub

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

Jump to bottom

improve docs to better differentiate package_api_docs and public_member_api_docs #1373

Open
pq opened this issue Jan 17, 2019 · 1 comment
Open

improve docs to better differentiate package_api_docs and public_member_api_docs #1373

pq opened this issue Jan 17, 2019 · 1 comment
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug

Comments

@pq
Copy link
Member

pq commented Jan 17, 2019

Follow-up from #1368 (comment):

Also, it's hard to tell the difference between these two lints, but maybe that's just a matter for the help text:

package_api_docs
public_member_api_docs

We should improve these docs.
@pq pq added contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) type-documentation A request to add or improve documentation labels Jan 17, 2019
@pq pq mentioned this issue Jan 17, 2019
Closed
@srawlins srawlins added the P2 A bug or feature request we're likely to work on label Sep 22, 2022
@srawlins srawlins added the type-enhancement A request for a change that isn't a bug label Mar 29, 2024
@pq pq mentioned this issue Apr 22, 2024
Open
@bwilkerson
Copy link
Member

Whether we should improve the docs for package_api_docs might depend on whether it's going to be removed. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pq @srawlins @bwilkerson