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

Provide mechanism for documenting known bugs or shortcomings #34057

Open
jonhoo opened this issue Jun 3, 2016 · 1 comment
Open

Provide mechanism for documenting known bugs or shortcomings #34057

jonhoo opened this issue Jun 3, 2016 · 1 comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jonhoo
Copy link
Contributor

jonhoo commented Jun 3, 2016

Go has a fairly poorly documented feature that lines marked with BUG are shown under "Bugs" in documentation for a package. The keywords can be configured using the (again poorly documented) -notes argument to godoc. This can be used to document known bugs and shortcomings of a package alongside the package's main documentation. For examples, see the bottom of net, sync/atomic, or encoding/xml.

Having a similar feature in rustdoc would be really useful, as it establishes a standard way of communicating known problems, which could prevent unnecessary bug reports, and encourage dialogue about known limitations. If it were also possible to link to the discussion for a given feature or bug, that would make it even better.

Thoughts?
@jonhoo jonhoo mentioned this issue Jun 3, 2016
Closed
@Mark-Simulacrum Mark-Simulacrum added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 4, 2017
@steveklabnik steveklabnik added the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 25, 2017
@steveklabnik
Copy link
Member

Triage: no changes

@ehuss ehuss removed the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@steveklabnik @ehuss @jonhoo @Mark-Simulacrum