Improve API doc for users
Maintainers usually reply within 3 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Review the published API documentation at https://appium.github.io/python-client-sphinx/ first, then compare it with the Sphinx examples and Napoleon Config references listed in the issue. Identify concrete user-facing gaps and update the documentation; done means the API reference is more user friendly.
Written by the indexing model from the issue text.
Description
The problem
Just published API doc.
https://appium.github.io/python-client-sphinx/
However, it is just first revision and could be more user friendly.
References
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 570
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 24
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
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.
More from appium/python-client
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
appium/python-client#1230 · 1 comment ·
Maintainers usually reply within 3 days
-
question
Difficulty 4/5 3-5 days Newbie friendliness 25/100
appium/python-client#1168 · 9 comments ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
appium/python-client#1147 · 7 comments ·
Maintainers usually reply within 3 days
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
appium/python-client#1091 · 4 comments ·
Maintainers usually reply within 3 days
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
appium/python-client#1076 · 2 comments ·
Maintainers usually reply within 3 days
All issues in appium/python-client
Similar issues
-
pydanty:is-working
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pydantic/pydantic-ai#8843 ·
Maintainers usually reply within 1 day
-
breaking change enhancement server
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sktime/sktime#11310 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day