search

spakin / SimpInkScr

Simple Inkscape Scripting
https://inkscape.org/~pakin/%E2%98%85simple-inkscape-scripting
GNU General Public License v3.0
320 stars 31 forks source link

[Wiki] Improve VSCode/external editor running instructions #137

Closed swebra closed 1 month ago

swebra commented 1 month ago

This is a PR for the wiki, but being submitted as an issue due to GitHub not supporting real wiki PRs. Changes are in my wiki fork (https://github.com/swebra/SimpInkScr.wiki.git), with the revision history here and the rendered wiki page section here.

This updates the VSCode instructions to

  1. Use the default repo name in launch.json (SimpInkScr rather than simple_inkscape_scripting), which should be the case for anyone following the README installation instructions
  2. Use Python type hinting to inform VSCode of the available Simple Inkscape Scripting functions and variables. This largely avoids the shortcomings of the previous instructions and should be largely applicable to other external editors.

If you've never managed wiki PRs like this before (I hadn't either!), see this gist.

spakin commented 1 month ago

Thanks for the PR and for the pointer to the instructions for merging wiki PR. I pushed your changes to the wiki.