Have runnable API examples (that can run from the documentation directly).
Open
documentation
enhancement
stale
- Dominant language
- Python
- Stars
- 4.4k
- Forks
- 437
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 15
Description
It would be useful to have API usage examples that could actually trigger a request on a real service.
Contributor guide
Research direction
Start by reviewing the existing API documentation and its current example entry points. Define how an example can issue a request against a real service and what setup it requires; the work is done when the documented examples run directly and demonstrate a real API request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100