demberto/PyFLP

📘 Make docstrings IDE agnostic

Offen

#52 geöffnet am 18.09.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (26 Forks)auto 404
docsgood first issuehelp wanted

Repository-Metriken

Stars
 (202 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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!

Contributor Guide

Research-Richtung
Untersuche die IDE Kompatibilität von Markdown Docstrings in PyCharm vs. VSCode und aktualisiere die Dokumentation.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Markdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75