Improve non-normative command descriptions and examples
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 718
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Many people have requested that we explain in layman terms what commands do and how they interact with eachother. In #1105 and #1231 we removed or modified command introductions into notes (like HTML has) to avoid confusion over normative introductory language.
This issue will track improving comamnd descriptions and their examples so the specification will be easier to read for client implementors and users.
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 reading the changes referenced in issues #1105 and #1231, then review the WebDriver command descriptions and examples covered by this issue. Identify which introductions need clearer non-normative explanations and document the intended improvements; done means the affected descriptions and examples are easier for implementors and users to understand.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100