testcontainers / testcontainers/testcontainers-python

Improve DockerCompose documentation

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

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

🐣 good first issue 📖 documentation 🛟 help wanted
主要言語
Python
スター
2.3k
フォーク
386
平均マージ
4時間 40分
マージ済み PR(30日)
1

説明

Hi. I'm starting to use testcontainers to test the behavior of a simple P2P network written in Python. I noticed that the auto-generated documentation for each class is just a copy of the constructor (without parameters descriptions) and a small code example. It would be really helpful if, at least, a small description of the behavior of each available method for each class was provided. Then this could be improved by adding a small description of the meaning of each parameter.

Small addition: for some reason, the documentation has really big margins on the left and the right but the title is too long.
Screenshot (113)

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

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

はじめの一歩

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

調査の方向性

Issue にリンクされている生成済みドキュメントから始め、DockerCompose クラスとそのメソッドページを見つけてください。メソッドの動作とパラメーターの意味を文書化する前に、ドキュメントがどのように生成され、スタイル設定されているかを確認してください。ページで利用可能なメソッドとパラメーターが説明され、過剰な余白と長すぎるタイトルが修正されていれば完了です。

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

評価

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

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

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