Add doc string max length to the contribution guidelines
Open
Nobody has claimed this yet.
docs
- Dominant language
- Rust
- Stars
- 56.1k
- Forks
- 1.7k
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 22
Description
From this discussion I found that for doc strings you must count in the extra 4 chars for /// . As I explained later, it does have a few drawbacks, but if it's a standard that has been around since the start (and assuming all other doc strings follow it), then at least it should be mentioned in the contribution guide (https://github.com/typst/typst/blob/main/CONTRIBUTING.md).
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
Read CONTRIBUTING.md and the linked discussion on pull request 4587 first. Update the contribution guidelines to mention the doc-string maximum length and that the extra four characters in /// count toward it; done means the convention is explicitly documented.
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
- 58/100