demberto/PyFLP

📘 Make docstrings IDE agnostic

Aberta

#52 aberto em 18 de set. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Python (26 forks)auto 404
docsgood first issuehelp wanted

Métricas do repositório

Stars
 (202 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Images and tables are a very integral part of PyFLP. Most properties use markdown image links. These perfectly work in VSCode but PyCharm, for example doesn't. Similarly for tables, VSCode supports the GFM syntax, but PyCharm supports rST tables.

I do dev in VSCode and plan to keep docstrings in markdown. If there's no IDE agnostic solution. If PyCharm has a extension which supports markdown in docstrings please let me know of it, so I can add that info to the docs.

EDIT: Looks like this might never be possible. So, PyFLP users - GO VSCODE!

Guia do colaborador

Direção de pesquisa
Investigue a compatibilidade IDE de docstrings markdown no PyCharm versus VSCode e atualize a documentação.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Markdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75