Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs linkage #22

Open
logannc opened this issue Nov 19, 2020 · 0 comments · May be fixed by #28
Open

Docs linkage #22

logannc opened this issue Nov 19, 2020 · 0 comments · May be fixed by #28
Labels
1.0.0 Road to 1.0.0
Milestone

Comments

@logannc
Copy link
Owner

logannc commented Nov 19, 2020

https://blog.rust-lang.org/2020/11/19/Rust-1.48.html#easier-linking-in-rustdoc

pub mod foo {
    /// Some docs for `Foo`
    ///
    /// You may want to use `Foo` with [`Bar`].
    ///
    /// [`Bar`]: ../bar/struct.Bar.html
    pub struct Foo;
}

pub mod bar {
    /// Some docs for `Bar`
    ///
    /// You may want to use `Bar` with [`Foo`].
    ///
    /// [`Foo`]: ../foo/struct.Foo.html
    pub struct Bar;
}

We do reference other functions and things in docs, it would be good to add linkage.

@logannc logannc added the 1.0.0 Road to 1.0.0 label Nov 19, 2020
@logannc logannc added this to the 1.0 milestone Nov 19, 2020
@logannc logannc linked a pull request Mar 27, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 Road to 1.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant