apache / apache/pulsar-client-node
Documentation for ClientConfig parameters?
オープン
- 主要言語
- C++
- スター
- 164
- フォーク
- 98
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Hi,
There are multiple parameter settings for the ClientConfig,
https://github.com/apache/pulsar-client-node/blob/d2c0d1e374f8e9f25934bd679436da0872b6bc8e/index.d.ts#L25-L33
Is the documentation for these parameters available somewhere? Ideally I'd suggest adding some comments directly in the typescript definition, so users of the library can see some documentation while developing.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
まず index.d.ts の25-33行目にある ClientConfig パラメータの宣言を確認し、リポジトリ内の別の場所にドキュメントが存在するかを調べます。TypeScript 定義内でパラメータをドキュメント化するか、既存のドキュメントの場所を特定し、開発中にユーザーがパラメータの説明を見つけられることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- nodejs, typescript
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100