aws / aws/aws-encryption-sdk-python
Sphinx does not follow paths for class aliases for parameter types
- Lenguaje dominante
- Python
- Estrellas
- 255
- Forks
- 92
- Merge medio
- 2 d 17 h
- PR fusionados (30 d)
- 2
Descripción
## 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`.
Guía de contribución
Línea de trabajo
Inspecciona las definiciones de alias en src/aws_encryption_sdk/__init__.py en las líneas 72-73 y, a continuación, compara la documentación de cifrado generada con su enlace de origen. Sigue el módulo de Sphinx que genera enlaces a tipos de parámetros y verifica que la referencia al parámetro se resuelva en AlgorithmSuite en lugar de en una clase desconocida.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100