aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

Ouverte
#61 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
good first issue help wanted maintenance
Langage dominant
Python
Étoiles
255
Forks
92
Merge moyen
2 j 17 h
PR mergées (30 j)
2

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Inspectez les définitions d’alias dans src/aws_encryption_sdk/__init__.py aux lignes 72-73, puis comparez la documentation de chiffrement générée avec son lien source. Suivez le module Sphinx qui génère les liens vers les types de paramètres et vérifiez que la référence du paramètre se résout vers AlgorithmSuite plutôt que vers une classe inconnue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.