aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

Offen
#61 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
good first issue help wanted maintenance
Vorherrschende Sprache
Python
Sterne
255
Forks
92
Ø Merge
2 T. 17 Std.
Gemergte PRs (30 T.)
2

Beschreibung

## 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`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Inspect the alias definitions in src/aws_encryption_sdk/__init__.py at lines 72-73, then compare the generated encrypt documentation with its source link. Trace the Sphinx module that generates parameter-type links and verify that the parameter reference resolves to AlgorithmSuite rather than an unknown class.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.