More docs on WaveDB
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.3k
- Forks
- 371
- Avg merge
- 26d 1h
- Merged PRs (30d)
- 1
Description
Discussed in https://github.com/h2oai/wave/discussions/1660
Originally posted by mtanco October 5, 2022
Hello! I used WaveDB for the first time yesterday, and am not a regular SQLite user. I was having really hard time figuring out what the index was for / doing on the connection line in our docs:
from h2o_wave import connect
db = connect()["somerandomtext"]
And just stumbled upon this comment in one of the examples:
https://github.com/h2oai/wave/blob/23fb7ae5c102b509a416692883e5db34e804f134/py/examples/db.py#L25
It would be great to have that explained / details on the https://wave.h2o.ai/docs/wavedb/ page!
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
Read the WaveDB documentation page and the comment near line 25 of py/examples/db.py, then compare them with the connection example in the issue. Document what the string key passed to connect() does and how it relates to the database, with the finished explanation reflected on the wavedb page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, sqlite
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100