about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorZack M. Davis <code@zackmdavis.net>2018-06-30 08:34:31 -0700
committerWho? Me?! <mark-i-m@users.noreply.github.com>2018-07-04 17:14:02 -0500
commitc622464ef201125d32f5427bf1c04b33b8c89ff2 (patch)
treeb23adf8b532a939f7d02026e843f0487e257a529 /src/doc/rustc-dev-guide
parentabfac5a722b26bf0d45fb014030bc6bdb0089f5c (diff)
downloadrust-c622464ef201125d32f5427bf1c04b33b8c89ff2.tar.gz
rust-c622464ef201125d32f5427bf1c04b33b8c89ff2.zip
add links for `Span`, `CodeMap`, and `rustfix`
It's unfortunate that `code-monospaced` links don't render with link
colors (such that the reader needs to hover over them just to tell that
it is a link), but that's presumably a bug in MdBook, and not something
we need concern ourselves with here.
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/diag.md33
1 files changed, 19 insertions, 14 deletions
diff --git a/src/doc/rustc-dev-guide/src/diag.md b/src/doc/rustc-dev-guide/src/diag.md
index 6043a79b7be..389ba2bbcb3 100644
--- a/src/doc/rustc-dev-guide/src/diag.md
+++ b/src/doc/rustc-dev-guide/src/diag.md
@@ -5,14 +5,17 @@ This chapter is about how to emit compile errors and lints from the compiler.
 
 ## `Span`
 
-`Span` is the primary data structure in `rustc` used to represent a location in
-the code being compiled. `Span`s are attached to most constructs in HIR and MIR,
-allowing for easier error reporting whenever an error comes up.
+[`Span`][span] is the primary data structure in `rustc` used to represent a
+location in the code being compiled. `Span`s are attached to most constructs in
+HIR and MIR, allowing for easier error reporting whenever an error comes up.
 
-A `Span` can be looked up in a `CodeMap` to get a "snippet" useful for
-displaying errors with [`span_to_snippet` and other similar methods][sptosnip]
-on the `CodeMap`.
+[span]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/codemap/struct.Span.html
 
+A `Span` can be looked up in a [`CodeMap`][codemap] to get a "snippet" useful
+for displaying errors with [`span_to_snippet`][sptosnip] and other similar
+methods on the `CodeMap`.
+
+[codemap]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/codemap/struct.CodeMap.html
 [sptosnip]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/codemap/struct.CodeMap.html#method.span_to_snippet
 
 ## Error messages
@@ -70,14 +73,16 @@ err.emit();
 ## Suggestions
 
 We would like to make edition transitions as smooth as possible. To that end,
-`rustfix` can use compiler suggestions to automatically fix code. For example,
-we could use `rustfix` to mechanically apply the `qux` suggestion from the
-previous example. However, not all suggestions are mechanically applicable.  We
-use the [`span_suggestion_with_applicability`][sswa] method of
-`DiagnosticBuilder` to inform the emitter of whether a suggestion is
-mechanically applicable or not.  This information, in turn, is outputed by
-rustc when the error format is `json`, which is used by `rustfix`.
-
+[`rustfix`][rustfix] can use compiler suggestions to automatically fix
+code. For example, we could use `rustfix` to mechanically apply the `qux`
+suggestion from the previous example. However, not all suggestions are
+mechanically applicable.  We use the
+[`span_suggestion_with_applicability`][sswa] method of `DiagnosticBuilder` to
+inform the emitter of whether a suggestion is mechanically applicable or not.
+This information, in turn, is outputed by rustc when the error format is
+`json`, which is used by `rustfix`.
+
+[rustfix]: https://github.com/rust-lang-nursery/rustfix/
 [sswa]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.DiagnosticBuilder.html#method.span_suggestion_with_applicability
 
 For example, to make our `qux` suggestion machine-applicable, we would do: