Improve documentation
Aperta
- Lingua principale
- Python
- Stelle
- 99
- Fork
- 8
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Currently the docs are comprised of a tutorial rendered from a notebook, and an API reference built form the python docstrings. We should expand the docs to include:
- [ ] An introduction to lens.
- [ ] A motivation of the choice of precomputing the summary vs computing it on-the-fly. Advantages of using dask?
- [ ] Tutorial for computing a summary and using the `Summary` and `Explorer` classes.
- [ ] Contribution guidelines.
- [ ] Structure API docs in a more clear way.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Valutazione
Questa issue non è ancora stata valutata.