OpenZeppelin / OpenZeppelin/rust-contracts-stylus
[Feature]: New Docs Format
Open
Nobody has claimed this yet.
effort: high
good first issue
type: docs
- Dominant language
- Rust
- Stars
- 146
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
What is the feature you would like to see?
/// <<General Description>>
///
/// # Examples (if there are any)
///
/// <<Example Description>>
/// <<Examples>>
///
/// NOTE: <<if a single one>>
/// <<or if many>>
/// NOTE:
/// * <<note1>>
/// * <<note2>>
///
/// # Arguments
///
/// * `arg1` - <<description>>
/// * `arg2` - <<description>>
///
/// # Errors
///
/// * [`Error::First`] - <<description>>
/// * [`Error::Second`] - <<description>>
///
/// # Panics (if any)
///
/// * <<panic1 description>>
/// * <<panic2 description>>
///
/// # Events
///
/// * [`Event1`] - <<optional description, only if not always emitted>>
/// * [`Event2`] - <<optional description, only if not always emitted>>
Example expected tooltip below:
Blocked until stylus@0.8.0 is released, which should include constructors, multiple #[public] impls, etc.
Related https://github.com/OpenZeppelin/rust-contracts-stylus/issues/476
Contribution Guidelines
- I agree to follow this project's Contribution Guidelines
Contributor guide
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 by reviewing related issue #476 and the Stylus 0.8.0 release status, since this request is explicitly blocked on that release. Define the proposed Rust documentation format and tooltip behavior; the work is done when the format can be supported after the listed Stylus features are available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- blockchain, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100