Add `Parameters` and `Returns` as part of the common headings in RFC 1574
Open
Nobody has claimed this yet.
A-convention
T-doc
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
RFC 1574 gives the following list of updated common headings:
- Examples
- Panics
- Errors
- Safety
- Aborts
- Undefined Behavior
This list misses the formal parameters for function/method calls, as well as a description of what is returned. Can you please add Parameters and Returns as two more common headings?
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
Open text/1574-more-api-documentation-conventions.md and review the common-headings list described in RFC 1574. Add Parameters and Returns to that list, then verify the RFC text reflects both requested headings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100