aws / aws/amazon-redshift-python-driver

docs: client_protocol_version missing from Connection Parameters table

オープン 初心者向け
#276 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Python
スター
220
フォーク
86
PR マージ指標
30日以内にマージされた PR はありません

説明

The README references client_protocol_version under "Client Transfer Protocol," stating it can modify the protocol version. However, this parameter is:



  1. Absent from the Connection Parameters table

  2. Has no usage example or valid values documented


Suggested addition to the parameters table:

Parameter | Type | Default | Description
-- | -- | -- | --
client_protocol_version | int | 2 | Controls the wire protocol version for data transfer

Example:


conn = redshift_connector.connect(

host='cluster.abc123.us-east-1.redshift.amazonaws.com',
database='dev',
user='admin',
password='***',
client_protocol_version=2
)

Happy to open a PR if maintainers can confirm the valid values.

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

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

調査の方向性

README の Client Transfer Protocol セクションと Connection Parameters テーブルから始めます。そこでは client_protocol_version が参照されていますが、一覧には記載されていません。maintainers に有効な値を確認してから、パラメーターの型、デフォルト値、説明、有効な値、および Python の接続例をドキュメント化します。テーブルと使用方法のドキュメントでパラメーターが一貫して扱われていれば完了です。

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

評価

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

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

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