Change:
Also figure out where the docs belong when it stabilizes. The implementation has diverged a bit from the original RFC (rust-lang/rfcs). We should have some good docs on all the syntaxes supported. cc <!-- TRIAGEBOTSTART --<!-- TRIAGEBOTASSIGNSTART --This issue has been assigned to via . <!-- TRIAGEBOTASSIGNDATASTARTTRIAGEBOTASSIGNDATAEND --<!-- TRIAGEBOTASSIGNEND --<!-- TRIAGEBOTEND --
Hi, I'm surfing throughout the getting started issues so I can conritbute for the first time, does this still need help?
I'd like to take a look at this claim
Oh, do you still want to do this? Sorry, I missed your comment
Yeah, I would be happy to help. But I found a little bit hard to understand what issues are still looking for help. I am completley new to rust so even tho this is a easy issue perhaps it will take me a little bit more time, if you find you can fix this quick, go ahead.
I think everyone is in the same position. But go ahead, take this release-assignment
claim

Discussion:
Attempting to use these error numbers on stable will result in the code sample being interpreted as plain text. <del> ### Linking to items by type </del> <ins> ### Linking to items by name </ins> <del> As designed in [RFC 1946], Rustdoc can parse paths to items when you use them as links. To resolve these type names, it uses the items currently in-scope, either by declaration or by `use` statement. For modules, the "active scope" depends on whether the documentation is written outside the module (as `///` comments on the `mod` statement) or inside the module (at `//!` comments inside the file or block). For all other items, it uses the enclosing module's scope. </del> <ins> Rustdoc is capable of directly linking to other rustdoc pages in Markdown documentation using the path of item as a link. </ins> <del> [RFC 1946]: https://github.com/rust-lang/rfcs/pull/1946 For example, in the following code: </del> <ins> For example, in the following code all of the links will link to the rustdoc page for `Bar`: </ins> ```rust <del> /// Does the thing. pub fn do_the_thing(_: SomeType) { println!("Let's do the thing!"); } </del> <ins> /// This struct is not [Bar] pub struct Foo1; /// This struct is also not [bar](Bar) pub struct Foo2; /// This struct is also not [bar][b] /// /// [b]: Bar pub struct Foo3; /// This struct is also not [`Bar`] pub struct Foo4; </ins> <del> /// Token you use to [`do_the_thing`]. pub struct SomeType; </del> <ins> pub struct Bar; </ins> ``` <del> The link to ``[`do_the_thing`]`` in `SomeType`'s docs will properly link to the page for `fn do_the_thing`. Note that here, rustdoc will insert the link target for you, but manually writing the target out also works: </del> <ins> You can refer to anything in scope, and use paths, including `Self`. You may also use `foo()` and `foo!()` to refer to methods/functions and macros respectively. </ins> <del> ```rust pub mod some_module { /// Token you use to do the thing. pub struct SomeStruct; } </del> <ins> ```rust,edition2018 use std::sync::mpsc::Receiver; </ins> <del> /// Does the thing. Requires one [`SomeStruct`] for the thing to work. </del> <ins> /// This is an version of [`Receiver`], with support for [`std::future`]. </ins> /// <del> /// [`SomeStruct`]: some_module::SomeStruct pub fn do_the_thing(_: some_module::SomeStruct) { println!("Let's do the thing!"); </del> <ins> /// You can obtain a [`std::future::Future`] by calling [`Self::recv()`]. pub struct AsyncReceiver<T> { sender: Receiver<T> } impl<T> AsyncReceiver<T> { pub async fn recv() -> T { unimplemented!() } </ins> } ``` <del> For more details, check out [the RFC][RFC 1946], and see [the tracking issue][43466] for more information about what parts of the feature are available. </del> <ins> Paths in Rust have three namespaces: type, value, and macro. Items from these namespaces are allowed to overlap. In case of ambiguity, rustdoc will warn about the ambiguity and ask you to disambiguate, which can be done by using a prefix like `struct@`, `enum@`, `type@`, `trait@`, `union@`, `const@`, `static@`, `value@`, `function@`, `mod@`, `fn@`, `module@`, `method@` , `macro@`, or `derive@`: ```rust /// See also: [`Foo`](struct@Foo) struct Bar; /// This is different from [`Foo`](fn@Foo) struct Foo {} fn Foo() {} ``` </ins> <del> [43466]: https://github.com/rust-lang/rust/issues/43466 </del> <ins> Note: Because of how `macro_rules` macros are scoped in Rust, the intra-doc links of a `macro_rules` macro will be resolved relative to the crate root, as opposed to the module it is defined in. </ins> ## Extensions to the `#[doc]` attribute