Unify explanation of the extern qualifier
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start by comparing the "Extern block item," "Function item," and ABI sections to map the duplicated extern qualifier and ABI details. Move the ABI material to the appropriate ABI section, create a unified extern qualifier section, and replace the existing explanations with brief references; done means the relevant behavior is explained without requiring readers to consult all three sections.
Written by the indexing model from the issue text.
Description
Right now, the explanation of the extern qualifier is split into the "Extern block item" and the "Function item" section, where the "Extern block item" section also contains multiple relevant details about ABIs.
This ends up requiring users that want to check some property of how these parts of the language work to visit the ABI, the extern block, and the function sections of the reference to get the whole picture.
I think it would be better to:
- move the ABI details described in the "extern block" section to an appropriate section (e.g. the ABI section)
- move the explanation of the
externqualifier (in extern block items and function items) to its own section - change the function and extern block sections to just briefly mention the extern qualifier, and refer users to that section
That should make it much easier to explain what the extern qualifier works.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 12
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.
More from rust-lang/reference
-
A-const-eval A-undefined-behavior
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
A-resolve
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
A-coercions
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in rust-lang/reference
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100