Add Description to what stuff does in `html5ever/examples/*`
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.6k
- Forks
- 288
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 8
Description
It would be good to have some comments in all examples in html5ever/examples/ to show what the examples do and what each part does.
This would be great for someone like me who is new to this library(s) to show what part is needed and what happens.
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 by reviewing the examples in html5ever/examples/* and read each one to identify its purpose and the roles of its main parts. Add explanatory comments throughout every example so a newcomer can understand what each example demonstrates and which parts are needed; done means all examples have clear descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100