NASA-AMMOS / NASA-AMMOS/AIT-Core
DB API documentation is lacking
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
The current DB API documentation isn't great
https://ait-core.readthedocs.io/en/latest/databases.html
We're going to need to make changes here anyway as part of #303 so we should make sure to expand on the existing details.
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 with the DB API documentation at databases.html and review the related work in issue #303. Identify which existing API details need expansion, then update the page as part of that work. Done means the database documentation is substantially more complete alongside the changes planned in #303.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- database, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100