Rather outdated docs on RTD

オープン
#217 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

まず Read the Docs の設定と、issue でリンクされている API ページのドキュメントソースを調べ、次にそれらを changelog および現在のプロジェクト名と比較します。ドキュメントのビルドがどのように設定されているかを確認し、新しい解凍オプションと現在の名前が反映されるように公開済みドキュメントを更新します。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
154
フォーク
34
平均マージ
1日 1時間
マージ済み PR（30日）
3

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

python-hyper/brotlicffi のほかの issue

python-hyper/brotlicffi の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。