Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📘 Make docstrings IDE agnostic #52

Open
demberto opened this issue Sep 18, 2022 · 1 comment
Open

📘 Make docstrings IDE agnostic #52

demberto opened this issue Sep 18, 2022 · 1 comment
Labels
docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@demberto
Copy link
Owner

demberto commented Sep 18, 2022

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!

@demberto demberto added docs Improvements or additions to documentation help wanted Extra attention is needed question Further information is requested labels Sep 18, 2022
@demberto demberto removed the question Further information is requested label Oct 26, 2022
@demberto demberto added this to the 2.1.0 milestone Mar 23, 2023
@demberto demberto added the good first issue Good for newcomers label Mar 23, 2023
@demberto
Copy link
Owner Author

demberto commented Mar 23, 2023

I just noticed that VS Code has started supporting RST's simple tables.
RST tables in VS Code

Unfortunately links don't yet work :(

EDIT: Too bad, it works only for 2 columns at max.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant