search

gtalarico / ironpython-stubs

Autocomplete stubs for common IronPython/.NET libraries
Other
248 stars 80 forks source link

Poor documentation #11

Closed ThomasMahon closed 6 years ago

ThomasMahon commented 6 years ago

The documentation for both Atom and Sublime is extremely poor and is insufficient to successfully set up either editor.

Can you either update the documentation so time isn't wasted second-guessing what needs to be done (given up on both, and that was before I even got to the stubs!) or provide links to instructions online that provide adequate set-up instructions for these text editors.

ThomasMahon commented 6 years ago

The problem was ordinary Python has to be installed - can you ensure this step is highlighted in your documentation (and thanks for the stubs repository - its greatly appreciated)

gtalarico commented 6 years ago

I don't think it's fair for you to say the documentation is "extremely poor and is insufficient". There are 3 Wiki pages for individual editors with step by step, screenshots and gifs.

The documentation on how to configure each autocomplete engine is provided here mostly out of courtesy, as the setup of standard python autocomplete is outside the scope of this project.

Both pages explicitly state you should have standard python autocompletion working before you attempt to add the stubs.

It's also rude and completely inappropriate to use this tone on an open source project created and maintained on one's free time and will. If you are having issues you are always welcome to ask for help or clarification, but you should reconsider your approach.

ThomasMahon commented 6 years ago

Hi Gui

You're right it was a bit OTT, so please excuse my tone. I greatly appreciate and admire the work you do - its very impressive and I do understand how much time and care it takes to provide it given much of the stuff I publish for free myself. I'll rephrase! The documentation would be perfect if it could clarify that vanilla python is required to get intellisense (Only IronPython is installed with Dynamo and when the documentation mentioned the Make sure auto-completion is working for your default python packages I interpreted this to mean the standard libraries in the IronPython lib folder. It was only after I installed Python from python.org did everything start working.

Thanks once again for the stubs and making this possible