demberto/PyFLP

📘 Make docstrings IDE agnostic

Ouverte

#52 ouverte le 18 sept. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (26 forks)auto 404
docsgood first issuehelp wanted

Métriques du dépÎt

Stars
 (202 étoiles)
MĂ©triques de merge PR
 (Métriques PR en attente)

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!

Guide contributeur

Direction de recherche
Étudiez la compatibilitĂ© IDE des docstrings markdown dans PyCharm vs VSCode et mettez Ă  jour la documentation.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un trÚs petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraßche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critÚres d'acceptation et la prochaine étape.
Claire
Prérequis
Markdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75