API: add sample input and output to commands
Open
Nobody has claimed this yet.
api
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
We should consider adding sample table data and the output of ReQL commands to every example.
This would likely require a widget with three tabs: example, sample data, and output. We should look at other complex APIs to find constructive examples.
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
The issue names no files or tests. Start by surveying the documentation examples and existing complex-API widgets, then define how example, sample data, and output should be presented for each ReQL command. Done means every example has representative table data and corresponding command output in the agreed widget format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100