Ketho / vscode-wow-api

VS Code extension for World of Warcraft AddOns
https://marketplace.visualstudio.com/items?itemName=ketho.wow-api
MIT License
142 stars 31 forks source link

(Request) Include the text description in the header of API docs #142

Open brittyazel opened 4 months ago

brittyazel commented 4 months ago

I used to maintain a similar project for IntelliJ's EmmyLUA plugin here, but have begin using yours full-time as it is far superior to what I was able to accomplish on my own. That being said, there is one small thing that I prefered from my old implementation, and that was that I had function descriptions listed just above the URL lines in the API docs, as you can see here. Having the description in the tooltip can help considerably with autocomplete suggestions and ease of development, at least for me, and right now all we have is a direct link to the wiki page, but not actual in-IDE context.

I don't imagine it would be too difficult to add, as I image whatever engine you use to source the API info from the wiki has access to these descriptions, much in the same way as I had before. Thanks again!

Ketho commented 4 months ago

Adding the function description sounds like a great idea, I think I didn't bother with parsing the description since it wasn't trivially easy to do, but you were able to anyhow.

I'm currently working to a deadline this Sunday, I'll try to spend more time on your requests afterwards.

brittyazel commented 4 months ago

Appreciated! I'd help implement it myself, but I haven't yet cloned your project and dug through your functions. So I wouldn't even know where to begin lol.

Ketho commented 4 months ago

The code is pretty crap and there is no documentation. It's ironic