demberto/PyFLP

馃摌 Make docstrings IDE agnostic

Open

#52 opened on Sep 18, 2022

View on GitHubContributor guide
聽(1 comment)聽(0 reactions)聽(0 assignees)Python聽(26 forks)auto 404
docsgood first issuehelp wanted

Repository metrics

Stars
聽(202 stars)
PR merge metrics
聽(PR metrics pending)

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!

Contributor guide

Research direction
Investigate IDE compatibility for markdown docstrings in PyCharm vs VSCode and update documentation.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75