Commit 918a4ee

committed

Add documentation for new example intra-doc link disambiguator

1 parent 5d0a044 commit 918a4eeCopy full SHA for 918a4ee

File tree

+21

-0

lines changed

+21

-0

lines changed

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,24 @@ Rustdoc has a few techniques to ensure these examples don't overwhelm documentat`
`47`	`47`
`48`	`48`	`For a given item, Rustdoc sorts its examples based on the size of the example — smaller ones are shown first.`
`49`	`49`
	`50`	`+## Linking to an example source code`
	`51`	`+`
	`52`	+You can use intra-doc links to link to a scraped example source file with `example@` disambiguator:
	`53`	`+`
	`54`	+```rust
	`55`	`+// If your example is named "foo":`
	`56`	`+/// [example@foo]`
	`57`	`+struct Item;`
	`58`	+```
	`59`	`+`
	`60`	+By default, the intra-doc link will link to the file containing the `main` function. If you want to
	`61`	`+link to another file, you can specify its path:`
	`62`	`+`
	`63`	+```rust
	`64`	`+// If your example is named "foo":`
	`65`	`+/// [example@foo/another_file.rs]`
	`66`	`+struct Item;`
	`67`	+```
`50`	`68`
`51`	`69`	`## FAQ`
`52`	`70`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -92,6 +92,9 @@ rendered as `Foo`. The following prefixes are available: `struct`, `enum`, `trai
`92`	`92`	`mod`, `module`, `const`, `constant`, `fn`, `function`, `field`, `variant`, `method`, `derive`,
`93`	`93`	`type`, `value`, `macro`, `prim` or `primitive`.
`94`	`94`
	`95`	+There is another disambiguator available: `example`. If you want more information about this one,
	`96`	`+take a look at the [scraped examples chapter](../scraped-examples.md).`
	`97`	`+`
`95`	`98`	You can also disambiguate for functions by adding `()` after the function name,
`96`	`99`	or for macros by adding `!` after the macro name. The macro `!` can be followed by `()`, `{}`,
`97`	`100`	or `[]`. Example:

Comments

(0)