Skip to content
This repository has been archived by the owner on Apr 26, 2019. It is now read-only.

Cull intellisense documentation to summary paragraph #14

Closed
MaulingMonkey opened this issue Jul 12, 2017 · 1 comment
Closed

Cull intellisense documentation to summary paragraph #14

MaulingMonkey opened this issue Jul 12, 2017 · 1 comment

Comments

@MaulingMonkey
Copy link
Owner

Ref: PistonDevelopers#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 MaulingMonkey changed the title Cull intellisense documentation Cull intellisense documentation to summary paragraph Jul 12, 2017
@MaulingMonkey
Copy link
Owner Author

MaulingMonkey commented Jul 12, 2017 •
edited

Implemented as of PistonDevelopers@96c62f8 (PR pending)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MaulingMonkey