Skip to content

Set up intra-doc links #97

Description

@sajattack

Intra-doc links just hit stable rust. This allows us to make links in the docs, which would be very helpful for doc comments like this one:

/// Wait until display list has finished executing
///
/// # Parameters
///
/// - `mode`: What to wait for, one of `GuSyncMode`
/// - `behavior`: How to sync, one of `GuSyncBehavior`
///

If someone out there wants an easy way to get started contributing to rust-psp, this is it.

More info:
https://blog.rust-lang.org/2020/11/19/Rust-1.48.html#easier-linking-in-rustdoc
https://doc.rust-lang.org/stable/rustdoc/linking-to-items-by-name.html

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions