aws / aws/aws-encryption-sdk-python
Sphinx does not follow paths for class aliases for parameter types
- Lingua principale
- Python
- Stelle
- 255
- Fork
- 92
- Merge medio
- 2g 17h
- PR unite (30g)
- 2
Descrizione
## 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`.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Esamina le definizioni degli alias in src/aws_encryption_sdk/__init__.py alle righe 72-73, quindi confronta la documentazione di crittografia generata con il relativo link sorgente. Segui il modulo Sphinx che genera i link ai tipi dei parametri e verifica che il riferimento al parametro venga risolto in AlgorithmSuite anziché in una classe sconosciuta.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100