search

MaulingMonkey / VisualRust

Visual Studio extension for Rust
MIT License
2 stars 0 forks source link

Cull intellisense documentation to summary paragraph #14

Closed MaulingMonkey closed 7 years ago

MaulingMonkey commented 7 years ago

Ref: https://github.com/PistonDevelopers/VisualRust/issues/290 Ref: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md

Convention docs have a "summary line" which should perhaps be what the docs are culled down to.

Alternatively, there's often a paragraph or two before the first # Heading which could also be included.

MaulingMonkey commented 7 years ago

Implemented as of https://github.com/PistonDevelopers/VisualRust/pull/286/commits/96c62f8e7b50b74783d6720d500c776b343ceddc (PR pending)