demberto / demberto/PyFLP

📘 Make docstrings IDE agnostic

Open
#52 1 comment 0 reactions 0 assignees View on GitHub
docs good first issue help wanted
Dominant language
Python
Stars
212
Forks
30
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.