python-hyper / python-hyper/brotlicffi
Rather outdated docs on RTD
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 154
- Forks
- 34
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 3
Description
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.
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 by inspecting the Read the Docs configuration and the documentation source for the API page linked in the issue, then compare it with the changelog and current project name. Confirm how the docs build is configured and update the published documentation so the new decompression options and current name are represented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100