Skip to content

Commit

Permalink
Use @ symbol in path ambiguity markers
Browse files Browse the repository at this point in the history
  • Loading branch information
Manishearth committed Jan 10, 2018
1 parent f337bea commit be38090
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions text/1946-intra-rustdoc-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,23 +290,23 @@ Our proposal is this:
For consistency,
it is also possible to prefix the type with the concrete item type:
- Links to `struct`s can be prefixed with `struct `,
e.g., `See [struct Foo]`.
e.g., `See [struct@Foo]`.
- Links to `enum`s can be prefixed with `enum `,
e.g., `See [enum foo]`.
e.g., `See [enum@foo]`.
- Links to type aliases can be prefixed with `type `,
e.g., `See [type foo]`.
e.g., `See [type@foo]`.
- Links to modules can be prefixed with `mod `,
e.g., `See [mod foo]`.
e.g., `See [mod@foo]`.
- In links to macros,
the link label must end with a `!`,
e.g., `Look at the [FOO!] macro`.
- For links to values, we differentiate three cases:
- Links to functions are written with a `()` suffix,
e.g., `Also see the [foo()] function`.
- Links to constants are prefixed with `const `,
e.g., `As defined in [const FOO].`
e.g., `As defined in [const@FOO].`
- Links to statics are prefixed with `static `,
e.g., `See [static FOO]`.
e.g., `See [static@FOO]`.

It should be noted that in the RFC discussion it was determined
that exact knowledge of the item type
Expand Down

0 comments on commit be38090

Please sign in to comment.