overdrivenpotato / overdrivenpotato/rust-psp
Set up intra-doc links
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 826
- Forks
- 44
- Avg merge
- 6d 10h
- Merged PRs (30d)
- 3
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by reviewing the repository's existing Rust documentation comments and documentation/build configuration, then read the linked Rust 1.48 rustdoc guidance. Done means intra-doc links are enabled or adopted where needed and the documentation build succeeds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100