mirror of
https://github.com/rust-lang/rust.git
synced 2025-04-17 14:36:49 +00:00
855b00cbe6
7570: Add doc gen to the `generate_enum_match_method` assist r=yoshuawuyts a=yoshuawuyts Implements a small extension to https://github.com/rust-analyzer/rust-analyzer/pull/7562, generating default comments. I wasn't sure if this would fit the goals of Rust-Analyzer, so I chose to split it into a separate PR. This is especially useful when writing code in a codebase which uses `#![warn(missing_docs)]` lint, as many production-grade libraries do. The comments we're generating here are similar to the ones found on [`Option::is_some`](https://doc.rust-lang.org/std/option/enum.Option.html#method.is_some) and [`Result::is_err`](https://doc.rust-lang.org/std/result/enum.Result.html#method.is_err). I briefly considered only generating these for `pub` types, but they seem small and unobtrusive enough that they're probably useful in the general case. Thanks! ## Example __input__ ```rust pub(crate) enum Variant { Undefined, Minor, // cursor here Major, } ``` __output__ ```rust pub(crate) enum Variant { Undefined, Minor, Major, } impl Variant { /// Returns `true` if the variant is [`Minor`]. pub(crate) fn is_minor(&self) -> bool { matches!(self, Self::Minor) } } ``` ## Future Directions This opens up the path to adding an assist for generating these comments on existing `is_` methods. This would make it both easy to document new code, and update existing code with documentation. 7571: Cleanup decl_check r=Veykril a=Veykril bors r+ Co-authored-by: Yoshua Wuyts <yoshuawuyts@gmail.com> Co-authored-by: Lukas Wirth <lukastw97@gmail.com> |
||
|---|---|---|
| .. | ||
| assists | ||
| base_db | ||
| cfg | ||
| completion | ||
| flycheck | ||
| hir | ||
| hir_def | ||
| hir_expand | ||
| hir_ty | ||
| ide | ||
| ide_db | ||
| mbe | ||
| parser | ||
| paths | ||
| proc_macro_api | ||
| proc_macro_srv | ||
| proc_macro_test | ||
| profile | ||
| project_model | ||
| rust-analyzer | ||
| ssr | ||
| stdx | ||
| syntax | ||
| test_utils | ||
| text_edit | ||
| toolchain | ||
| tt | ||
| vfs | ||
| vfs-notify | ||