docs: Add command-line usage examples to the Candid reference section
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 301
- Forks
- 85
- Avg merge
- 1h 4m
- Merged PRs (30d)
- 4
Description
I often need a little more than the signature definitions to get the right syntax for specifying Candid values on the command line (for example, do I need to use equal sign or colon, comma or semi-colon?).
Adding.a usage example for each type would make it easy to look up this information.
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 with the Candid reference section and review the existing signature definitions and type listings. Add a command-line usage example for each type, clarifying syntax such as equals versus colon and commas versus semicolons. Done means every referenced type has an understandable example in the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100