rust-lang / rust

Empowering everyone to build reliable and efficient software.
https://www.rust-lang.org
Other
96.98k stars 12.54k forks source link

Tracking Issue for `rustdoc::missing_doc_code_examples` #101730

Open Nemo157 opened 2 years ago

Nemo157 commented 2 years ago

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

jplatte commented 1 year ago

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 commented 1 year ago

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

peter-lyons-kehl commented 1 year ago

@jplatte FYI related to rustdoc::all