Bookshelf icon indicating copy to clipboard operation
Bookshelf copied to clipboard

Add i/o to feature metadata

Open aksiome opened this issue 10 months ago • 3 comments

Suggestion or Inquiry

This is quite a long shot, but the idea is to leverage these metadata to create mcdoc files, which would improve their use with Spyglass. Additionally, this could help automatically generate documentation for features, significantly simplifying the documentation process.

aksiome avatar Feb 25 '25 20:02 aksiome

Do you have an example of which aid we can obtain from Spyglass by providing it with such mcdoc files?

theogiraudet avatar Feb 25 '25 20:02 theogiraudet

We can have autocompletion mainly for storages. I'm not sure if it's possible for macros at the moment, but if not, it might be in the future. Also, when installing Bookshelf through pip, the modules aren't loaded by Spyglass, so this could be a way to provide autocompletion for functions in that case.

aksiome avatar Feb 27 '25 00:02 aksiome

I think we should wait for IMP Doc v2, which will support defining impdoc files directly. Moving this out of the milestone for now.

aksiome avatar Jul 07 '25 12:07 aksiome