aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

オープン
#61 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
good first issue help wanted maintenance
主要言語
Python
スター
255
フォーク
92
平均マージ
2日 17時間
マージ済み PR(30日)
2

説明

## Problem
Even though `Algorithm` is an alias for `AlgorithmSuite`, it looks like the sphinx module that generates code links for parameter types doesn't realize that and just treats it as an unknown class.

ex:

render:

https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.html#aws_encryption_sdk.encrypt

src:

https://github.com/aws/aws-encryption-sdk-python/blob/master/src/aws_encryption_sdk/__init__.py#L72-L73

## Solution
Replace parameter type references with `AlgorithmSuite`.

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

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

調査の方向性

src/aws_encryption_sdk/__init__.py の72-73行目にあるエイリアス定義を調べ、次に生成された暗号化ドキュメントをそのソースリンクと比較します。パラメーター型へのリンクを生成する Sphinx モジュールを追跡し、パラメーター参照が未知のクラスではなく AlgorithmSuite に解決されることを確認します。

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

評価

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

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

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