doc: more doc comments and intra-doc links#11703
Merged
bors merged 7 commits intorust-lang:masterfrom Feb 12, 2023
Merged
Conversation
Collaborator
|
r? @epage (rustbot has picked a reviewer for you, use r? to override) |
epage
reviewed
Feb 12, 2023
Comment on lines
15
to
+16
| fn render_filename<P: AsRef<Path>>(path: P, basedir: Option<&str>) -> CargoResult<String> { | ||
| fn wrap_path(path: &Path) -> CargoResult<String> { |
Contributor
There was a problem hiding this comment.
Whats gained by doing this? Personally, I avoid inner functions unless I'm doing it for generics.
Member
Author
There was a problem hiding this comment.
One less item to show in the list of functions in rustdoc? But you're right not many gains.
Contributor
There was a problem hiding this comment.
Generally, when doing something to make things nicer for a tool, it makes me question the tool and not the code
Of course there are exceptions, like us wanting to use the auto-labeling as feedback on code organization
Contributor
|
Had a question but not really blocking for all of this. @bors r+ |
Contributor
Contributor
Contributor
|
☀️ Test successful - checks-actions |
weihanglo
added a commit
to weihanglo/rust
that referenced
this pull request
Feb 13, 2023
10 commits in 82c3bb79e3a19a5164e33819ef81bfc2c984bc56..39c13e67a5962466cc7253d41bc1099bbcb224c3 2023-02-04 22:52:16 +0000 to 2023-02-12 02:01:08 +0000 - chore: Update to toml v0.6, toml_edit v0.18 (rust-lang/cargo#11618) - doc: more doc comments and intra-doc links (rust-lang/cargo#11703) - Deny warnings in CI, not locally (rust-lang/cargo#11699) - add comment to lto.rs (rust-lang/cargo#11701) - Re-export cargo_new::NewProjectKind as public (rust-lang/cargo#11700) - Add '-C' flag for changing current dir before build (rust-lang/cargo#10952) - `-Zrustdoc-scrape-example` must fail with bad build script (rust-lang/cargo#11694) - Update CHANGELOG for 1.68 backports (rust-lang/cargo#11690) - Update 1password to the version 2 CLI (rust-lang/cargo#11692) - chore: autolabel more for `A-*` (rust-lang/cargo#11679)
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 14, 2023
Update cargo 10 commits in 82c3bb79e3a19a5164e33819ef81bfc2c984bc56..39c13e67a5962466cc7253d41bc1099bbcb224c3 2023-02-04 22:52:16 +0000 to 2023-02-12 02:01:08 +0000 - chore: Update to toml v0.6, toml_edit v0.18 (rust-lang/cargo#11618) - doc: more doc comments and intra-doc links (rust-lang/cargo#11703) - Deny warnings in CI, not locally (rust-lang/cargo#11699) - add comment to lto.rs (rust-lang/cargo#11701) - Re-export cargo_new::NewProjectKind as public (rust-lang/cargo#11700) - Add '-C' flag for changing current dir before build (rust-lang/cargo#10952) - `-Zrustdoc-scrape-example` must fail with bad build script (rust-lang/cargo#11694) - Update CHANGELOG for 1.68 backports (rust-lang/cargo#11690) - Update 1password to the version 2 CLI (rust-lang/cargo#11692) - chore: autolabel more for `A-*` (rust-lang/cargo#11679) r? `@ghost`
RalfJung
pushed a commit
to RalfJung/rust-analyzer
that referenced
this pull request
Apr 20, 2024
Update cargo 10 commits in 82c3bb79e3a19a5164e33819ef81bfc2c984bc56..39c13e67a5962466cc7253d41bc1099bbcb224c3 2023-02-04 22:52:16 +0000 to 2023-02-12 02:01:08 +0000 - chore: Update to toml v0.6, toml_edit v0.18 (rust-lang/cargo#11618) - doc: more doc comments and intra-doc links (rust-lang/cargo#11703) - Deny warnings in CI, not locally (rust-lang/cargo#11699) - add comment to lto.rs (rust-lang/cargo#11701) - Re-export cargo_new::NewProjectKind as public (rust-lang/cargo#11700) - Add '-C' flag for changing current dir before build (rust-lang/cargo#10952) - `-Zrustdoc-scrape-example` must fail with bad build script (rust-lang/cargo#11694) - Update CHANGELOG for 1.68 backports (rust-lang/cargo#11690) - Update 1password to the version 2 CLI (rust-lang/cargo#11692) - chore: autolabel more for `A-*` (rust-lang/cargo#11679) r? `@ghost`
RalfJung
pushed a commit
to RalfJung/rust-analyzer
that referenced
this pull request
Apr 27, 2024
Update cargo 10 commits in 82c3bb79e3a19a5164e33819ef81bfc2c984bc56..39c13e67a5962466cc7253d41bc1099bbcb224c3 2023-02-04 22:52:16 +0000 to 2023-02-12 02:01:08 +0000 - chore: Update to toml v0.6, toml_edit v0.18 (rust-lang/cargo#11618) - doc: more doc comments and intra-doc links (rust-lang/cargo#11703) - Deny warnings in CI, not locally (rust-lang/cargo#11699) - add comment to lto.rs (rust-lang/cargo#11701) - Re-export cargo_new::NewProjectKind as public (rust-lang/cargo#11700) - Add '-C' flag for changing current dir before build (rust-lang/cargo#10952) - `-Zrustdoc-scrape-example` must fail with bad build script (rust-lang/cargo#11694) - Update CHANGELOG for 1.68 backports (rust-lang/cargo#11690) - Update 1password to the version 2 CLI (rust-lang/cargo#11692) - chore: autolabel more for `A-*` (rust-lang/cargo#11679) 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
5 participants
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?
More docs and intra-doc links. (and some teeny-tiny refactor :P)
How should we test and review this PR?
Then proofread it!