aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

Aberta
#61 2 comentários 0 reações 0 responsáveis Ver no GitHub
good first issue help wanted maintenance
Linguagem predominante
Python
Estrelas
255
Forks
92
Merge médio
2d 17h
PRs com merge (30d)
2

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Inspecione as definições de alias em src/aws_encryption_sdk/__init__.py nas linhas 72-73 e, em seguida, compare a documentação de criptografia gerada com seu link de origem. Rastreie o módulo Sphinx que gera links para tipos de parâmetros e verifique se a referência do parâmetro é resolvida para AlgorithmSuite, em vez de uma classe desconhecida.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Bug
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.