Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: Cargo feature descriptions #3485

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

RFC: Cargo feature descriptions #3485

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7aa7df0
Add initial feature-documentation RFC split from feature-metadata
tgross35 Sep 9, 2023
c52bd96
Update RFC number
tgross35 Sep 9, 2023
51400c5
Misc cleanup
epage Sep 10, 2023
129ab25
Make it clear that a decision on markdown has not yet been reached
tgross35 Sep 15, 2023
326b4d9
Update text/3485-feature-documentation.md
tgross35 Jul 9, 2024
6a793f5
Update text/3485-feature-documentation.md
tgross35 Jul 9, 2024
4957dd0
Update text/3485-feature-documentation.md
tgross35 Jul 9, 2024
9cc3334
Update text/3485-feature-documentation.md
tgross35 Jul 9, 2024
9d87695
Update text/3485-feature-documentation.md
tgross35 Jul 9, 2024
b6d13a6
Add note about rustdoc support of links
tgross35 Jul 15, 2024
c330adb
Apply formatting
tgross35 Jul 15, 2024
b2b27a2
Add an example in the summary
tgross35 Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add note about rustdoc support of links
  • Loading branch information
@tgross35
tgross35 committed Jul 15, 2024
commit b6d13a63462ba55593b0114c035dd7413873f7a5
5 changes: 5 additions & 0 deletions text/3485-feature-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,11 @@ concerns about bloat, but this is further discussed in
[future-possibilities]: #future-possibilities

- Rustdoc can build on this to show feature documentation.

If this RFC gets stabilized before any corresponding change in rustdoc, its
documentation should highlight that rustdoc may parse the description and
support intra-doc links in the future, but not at the current time. Users need
to be aware of this potential incompatibility.
- At some point, the decision to not include `doc` in the index could be
reevaluated. Including only the first (summary) line of `doc` could be a
possibility.
Expand Down