headings in struct field documentation has confusing spacing
Open
Nobody has claimed this yet.
A-rustdoc-ui
T-rustdoc
T-rustdoc-frontend
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
example:
struct Foo {
/// blah blah blah
///
/// # Heading
///
/// blah blah blah
a: u8,
b: u16,
}
there will be a large upper margin on the heading, making it visually unclear what the second paragraph corresponds to.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the provided Rust struct example in generated documentation and compare the heading’s spacing with the surrounding paragraphs. Trace the documentation-rendering entry point responsible for struct field comments, then add regression coverage showing that the heading no longer has a confusing upper margin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100