python-hyper / python-hyper/brotlicffi
Rather outdated docs on RTD
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 154
- Fork
- 34
- Merge medio
- 1g 1h
- PR unite (30g)
- 3
Descrizione
I just had a look at the docs to see whether decompressing would allow specifying an output limit, which did not appear to be the case: https://python-hyper.org/projects/brotlipy/en/latest/api.html#brotli.Decompressor.decompress
According to the changelog, this has been changed and released a few days ago, but according to the build history, the RTD docs have not been generated for over seven years, thus these new options are missing: https://app.readthedocs.org/projects/brotlipy/builds/
By the way: The docs seem to still be under the old name which has been changed a few years ago, which is a bit confusing as well.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia ispezionando la configurazione di Read the Docs e la sorgente della documentazione per la pagina API collegata nell’issue, quindi confrontala con il changelog e il nome attuale del progetto. Conferma come è configurata la build della documentazione e aggiorna la documentazione pubblicata in modo che siano rappresentati le nuove opzioni di decompressione e il nome attuale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100