parallaxsecond / parallaxsecond/rust-cryptoki
Fix references in docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 115
- Forks
- 96
- Avg merge
- 22h 56m
- Merged PRs (30d)
- 2
Description
Originally posted by @wiktor-k in https://github.com/parallaxsecond/rust-cryptoki/pull/255#discussion_r2041560510
I wonder why this line couldn't just be:
/// See [Session::encrypt_message].
Is it becauseSessionis not in scope? (then it can be imported above with#[cfg(doc)]attribute) (we do something similar in signstar)
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
Start with the discussion on pull request #255 and inspect the documentation reference involving Session::encrypt_message. Determine why the reference needs adjustment and verify that the resulting Rust documentation links resolve correctly; the work is done when the references build without warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100