refactor and reword intra-doc link errors #74528
Merged
Conversation
This file contains 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
|
r? @ollie27 (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
r? @jyn514 |
jyn514
reviewed
Jul 20, 2020
| } | ||
|
|
||
| diag.help( | ||
| r#"to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`"#, |
There was a problem hiding this comment.
While we're cleaning up things, I think 'just' is a little dismissive.
Suggested change
| r#"to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`"#, | |
| r#"to escape `[` and `]` characters, add '\' before them: `\[` or `\]`"#, |
There was a problem hiding this comment.
Fixed. What I'd really like to do here is use a structured suggestion but I don't think that's feasible until pulldown-cmark/pulldown-cmark#373 is fixed.
| } | ||
|
|
||
| // FIXME: Create a version of this suggestion for when we don't have the span. |
There was a problem hiding this comment.
When would we not have a span? If it's expanded from a macro or something?
There was a problem hiding this comment.
Yep, or if raw #[doc] attributes are used.
Comment on lines
219
to
221
| if extra_fragment.is_some() { | ||
| return Err(ErrorKind::AnchorFailure( | ||
| "primitive types cannot be followed by anchors", | ||
| )); | ||
| return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive)); | ||
| } |
There was a problem hiding this comment.
It would be nice to factor all this out somehow ... but I don't have a clear idea for how to do so.
euclio
force-pushed
the
intra-link-errors
branch
from
063da65
to
3b4c3e2
Compare
|
The CI failure is from |
This commit refactors intra-doc link error reporting to deduplicate code and decouple error construction from the type of error. This greatly improves flexibility at each error construction site, while reducing the complexity of the diagnostic creation. This commit also rewords the diagnostics for clarity and style: - Diagnostics should not end in periods. - It's unnecessary to say "ignoring it". Since this is a warning by default, it's already clear that the link is ignored.
euclio
force-pushed
the
intra-link-errors
branch
from
3b4c3e2
to
7f3e2c0
Compare
|
@bors r+ |
|
📌 Commit 7f3e2c0 has been approved by |
|
🌲 The tree is currently closed for pull requests below priority 5, this pull request will be tested once the tree is reopened |
bors
added
S-waiting-on-bors
jyn514
added
A-intra-doc-links
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Jul 22, 2020
refactor and reword intra-doc link errors This commit refactors intra-doc link error reporting to deduplicate code and decouple error construction from the type of error. This greatly improves flexibility at each error construction site, while reducing the complexity of the diagnostic creation. This commit also rewords the diagnostics for clarity and style: - Diagnostics should not end in periods. - It's unnecessary to say "ignoring it". Since this is a warning by default, it's already clear that the link is ignored.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jul 22, 2020
…arth Rollup of 9 pull requests Successful merges: - rust-lang#73655 (va_args implementation for AAPCS.) - rust-lang#73893 (Stabilize control-flow-guard codegen option) - rust-lang#74237 (compiletest: Rewrite extract_*_version functions) - rust-lang#74454 (small coherence cleanup) - rust-lang#74528 (refactor and reword intra-doc link errors) - rust-lang#74568 (Apply rust-lang#66379 to `*mut T` `as_ref`) - rust-lang#74570 (Use forge links for prioritization procedure) - rust-lang#74589 (Update books) - rust-lang#74635 (Fix tooltip position if the documentation starts with a code block) Failed merges: r? @ghost
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.
This commit refactors intra-doc link error reporting to deduplicate code
and decouple error construction from the type of error. This greatly
improves flexibility at each error construction site, while reducing the
complexity of the diagnostic creation.
This commit also rewords the diagnostics for clarity and style:
default, it's already clear that the link is ignored.