JakeStanger/rust-bindocs
1
0
Fork 0
mirror of https://github.com/JakeStanger/rust-bindocs.git synced 2026-07-11 11:15:43 +01:00
Code Issues 2 Projects Releases 1 Packages Wiki Activity Actions

[GH-ISSUE #2] Default value information #1

New issue
Open
opened 2026-05-22 22:04:40 +01:00 by JakeStanger · 0 comments
JakeStanger commented 2026-05-22 22:04:40 +01:00
Owner
Copy link

Originally created by @JakeStanger on GitHub (Jul 29, 2023).
Original GitHub issue: https://github.com/JakeStanger/rust-bindocs/issues/2

Both serde and clap provide default values via attributes on the type. It would be cool to automatically extract these and include them in the generated docs, along side the type information.

Clap should be fairly trivial since the literal value is included in the attribute. Serde-backed types will be harder, since they use a function to determine the value. It should be possible to cover at least some cases though.

Originally created by @JakeStanger on GitHub (Jul 29, 2023). Original GitHub issue: https://github.com/JakeStanger/rust-bindocs/issues/2 Both `serde` and `clap` provide default values via attributes on the type. It would be cool to automatically extract these and include them in the generated docs, along side the type information. Clap should be fairly trivial since the literal value is included in the attribute. Serde-backed types will be harder, since they use a function to determine the value. It should be possible to cover at least some cases though.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
v0.1.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
JakeStanger/rust-bindocs#1
No description provided.