Repository navigation
docs(hints): write mostly-unused docs as end-user documentation - #17549
Merged
Merged
Conversation
0xPoe
changed the title
0xPoe
force-pushed
the
docs-hint-mostly-unused
branch
2 times, most recently
from
October 5, 2026 13:58
26c1687 to
12527af
Compare
This comment has been minimized.
This comment has been minimized.
rustbot
added
the
S-waiting-on-author
0xPoe
force-pushed
the
docs-hint-mostly-unused
branch
2 times, most recently
from
October 26, 2026 09:08
8c32ed1 to
b494059
Compare
0xPoe
changed the title
0xPoe
marked this pull request as ready for review
October 26, 2026 09:10
rustbot
added
the
S-waiting-on-review
0xPoe
removed
the
S-waiting-on-author
0xPoe
commented
Oct 26, 2026
Member
Author
There was a problem hiding this comment.
🔢 Self-check (PR reviewed by myself and ready for feedback)
r? @weihanglo
0xPoe
changed the title
0xPoe
changed the title
weihanglo
reviewed
Oct 26, 2026
Comment on lines
+958
to
+961
| The valid options are: | ||
|
|
||
| * `true`: enabled | ||
| * `false`: disabled |
Member
There was a problem hiding this comment.
nit: why do we have an unordered list for profile but not for hint? Which writing style do we prefer and follow the eixsting style?
Member
Author
There was a problem hiding this comment.
profiles.md uses this style, so I chose to use it here. manifest.md uses a different style(Or no style😄). I do not think this is a big issue, and I can change either one if you think we should use one style throughout.
Signed-off-by: 0xPoe <poe.liu@pm.me>
0xPoe
force-pushed
the
docs-hint-mostly-unused
branch
from
October 26, 2026 20:05
b494059 to
df7af8d
Compare
weihanglo
approved these changes
Oct 26, 2026
weihanglo
enabled auto-merge
October 26, 2026 20:38
Merged
via the queue into
rust-lang:master
with commit Oct 26, 2026
a4590e4
111 of 117 checks passed
rustbot
removed
the
S-waiting-on-review
rust-bors Bot
pushed a commit
to rust-lang/rust
that referenced
this pull request
Oct 29, 2026
Update cargo submodule 7 commits in cad07cf8e597397fff5d0f6cb79c9f870c0b1dd2..31d3246e0e8d3a80d4a90b54aa48ff180adb408b 2026-10-23 22:04:58 +0000 to 2026-10-27 13:54:39 +0000 - Warn about conflicting proc-macro manifest settings (rust-lang/cargo#17641) - docs: use latest `resolver` and `edition` in examples (rust-lang/cargo#17644) - docs(hints): write mostly-unused docs as end-user documentation (rust-lang/cargo#17549) - refactor(help): embed man pages without a tarball (rust-lang/cargo#17640) - refactor(cargo-test-support): remove build.rs (rust-lang/cargo#17638) - fix: exclude abspath of path deps from `-Cmetadata` hash (rust-lang/cargo#17624) - use build-rs for buildscripts (rust-lang/cargo#17637) r? ghost
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
Inspired by #17368 (comment).
So I added the end-user documentation for it.
How to test and review this PR?
r?@ghost
Check the docs.