prometheus / prometheus/client_python

Improve documentation for Enum and Info classes

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

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

主要言語
Python
スター
4.4k
フォーク
876
平均マージ
8日 4時間
マージ済み PR(30日)
1

説明

In Instrumenting section of documentation (https://github.com/prometheus/client_python#instrumenting) there is written:

Four types of metric are offered: Counter, Gauge, Summary and Histogram.

Classes for exposing these metrics are then described and in addition there are mentioned also Info and Enum classes without explanation how these classes should be used and what type of metrics they expose. These should be documented in more detail.

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

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

はじめの一歩

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

調査の方向性

リポジトリのドキュメントの「Instrumenting」セクションから始め、既存のメトリクスクラスがどのように説明されているかを確認してください。Info クラスと Enum クラスの使用方法、およびそれらが公開するメトリクスタイプを文書化してください。両方のクラスについて、他のメトリクスタイプと同程度の説明が用意された時点で、このセクションは完成です。

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

評価

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

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

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