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

Need friendly intellisense descriptions for procedures in the standard library #26

Open
WaynePhillipsEA opened this issue Apr 15, 2021 · 2 comments
Labels
planned planned in a future release

Comments

@WaynePhillipsEA
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
At the moment, we've only got detailed intellisense descriptions for MsgBox and InputBox [as of 0.9.1602].

Describe the solution you'd like
All standard library functions, and enumerations etc should have nice detailed descriptions in intellisense / signature help.

@WaynePhillipsEA WaynePhillipsEA added the planned planned in a future release label Apr 15, 2021
@retailcoder
Copy link

If it doesn't entail much additional work, could the docstrings be open-sourced in some way? Rubberduck would definitely load them and display them if they were available somewhere!

@WaynePhillipsEA
Copy link
Collaborator Author

Yes, absolutely. Really good idea. A good format for twinBASIC would be a JSON based format, with the text being markdown. We'd need to consider language awareness -- perhaps a single JSON file per language/locale.

Currently, twinBASIC uses the full namespace IDs to match up the markdown text to the corresponding library procedure; e.g. 'VBA.Interaction.InputBox'. The idea was that later we could take it a step further and have this help text available for other third-party libraries like ADODB...

We could do it here, or perhaps in a separate repository, with a very permissive licence?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
planned planned in a future release
Projects
None yet
Development

No branches or pull requests

2 participants