Skip to content

Commit 0b17ddf

Browse files
committed
Add more disambiguators to match PR
1 parent ee53b90 commit 0b17ddf

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

text/1946-intra-rustdoc-links.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -307,15 +307,18 @@ Our proposal is this:
307307
- It is possible that disambiguators for one kind of type-namespace object
308308
will work for the other (i.e. you can use `struct@` to refer to an enum),
309309
but do not rely on this.
310+
- Modules exist in both the type and value namespace and can be disambiguated
311+
with a `mod@` or `module@`, e.g. `[module@foo]`
310312
- In links to macros,
311313
the link label can end with a `!`,
312314
e.g., `Look at the [FOO!] macro`. You can alternatively use a `macro@` prefix,
313315
e.g. `[macro@foo]`
314316
- For disambiguating links to values, we differentiate three cases:
315317
- Links to any kind of value (function, const, static) can be prefixed with `value@`,
316318
e.g., `See [value@foo]`.
317-
- Links to functions can be written with a `()` suffix,
318-
e.g., `Also see the [foo()] function`. You can also use `function@`.
319+
- Links to functions and methods can be written with a `()` suffix,
320+
e.g., `Also see the [foo()] function`. You can also use `function@`, `fn@`,
321+
or `method@`.
319322
- Links to constants are prefixed with `const@`,
320323
e.g., `As defined in [const@FOO].`
321324
- Links to statics are prefixed with `static@`,

0 commit comments

Comments
 (0)