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

Tracking Issue for rustdoc::missing_doc_code_examples #101730

Open
1 of 3 tasks
Nemo157 opened this issue Sep 12, 2022 · 3 comments
Open
1 of 3 tasks

Tracking Issue for rustdoc::missing_doc_code_examples #101730

Nemo157 opened this issue Sep 12, 2022 · 3 comments
Labels
C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Nemo157
Copy link
Member

Nemo157 commented Sep 12, 2022

This is a tracking issue for the lint rustdoc::missing_doc_code_examples.
The feature gate for the issue is #![feature(rustdoc_missing_doc_code_examples)].

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

Unresolved Questions

Implementation history
@Nemo157 Nemo157 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC labels Sep 12, 2022
@GuillaumeGomez GuillaumeGomez mentioned this issue Sep 12, 2022
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Sep 12, 2022
@GuillaumeGomez
Rollup merge of rust-lang#101732 - Nemo157:gate-rustdoc-missing-examp…
ac92cc8 
…les, r=GuillaumeGomez

Feature gate the `rustdoc::missing_doc_code_examples` lint

Moves the lint from being implicitly active on nightly `rustdoc` to requiring a feature to activate, like other unstable lints.

Uses the new tracking issue rust-lang#101730
@phip1611 phip1611 mentioned this issue Sep 26, 2022
Closed
2 tasks
kontza pushed a commit to kontza/mediawalker that referenced this issue Nov 19, 2022
Removed deny due to rust-lang/rust#101730. Made the example code to p…
0c556c2 
…ass tests.
@jplatte
Copy link
Contributor

jplatte commented Mar 23, 2023 •
edited
Loading

When this lands, could there be a new lint group like rustdoc::all that activates all non-"restriction" rustdoc lints? All the current lints in from https://doc.rust-lang.org/rustdoc/lints.html are very useful to deny in CI, but this one obviously isn't (for most people).

@peter-lyons-kehl
Copy link
Contributor

peter-lyons-kehl commented Mar 25, 2023 •
edited
Loading

Please add #109592 and its PR (if accepted), and #109601.

@peter-lyons-kehl
Copy link
Contributor

@jplatte FYI related to rustdoc::all

@Razican Razican mentioned this issue Oct 3, 2023
Open
@Skgland Skgland mentioned this issue Mar 5, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC 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
3 participants
@Nemo157 @jplatte @peter-lyons-kehl