You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.
Is your feature request related to a problem? Please describe.
Currently, the built-in help command invoked with ? only returns the Operation or Function name and docstring but not the type signature.
Describe the solution you'd like
I'd like to be able to see the type signature in the notebook instead of having to browse the docs to find them.
Describe alternatives you've considered
Additional context
Screenshot:
The text was updated successfully, but these errors were encountered:
Thanks for filing this! I think we should do this, but that would take adding an API to the qsharp-compiler repo (or exposing it if it already exists) to reconstruct the declaration syntax from a CallableDeclarationHeader.
To drill down a bit, the way ? works in jupyter-core and hence IQ# is to return a code symbol as a displayable object, and then use display encoders to render that into HTML, plain text, and so forth. IQ# already has a display encoder for Q# symbols, formatting them from the metadata contained in IQSharpSymbol. That class includes metadata automatically generated from documentation comments (#334), but at the moment there's no way to go back to Q# syntax data without using internal-only syntax generation methods.
@bettinaheim, would it be reasonable to expose some of the methods used in documentation generation for reproducing declaration syntax so that we can implement this suggestion?
Short of that, I think we should be able to pull at least some Markdown content from existing attributes and APIs:
Is your feature request related to a problem? Please describe.
Currently, the built-in help command invoked with
?
only returns the Operation or Function name and docstring but not the type signature.Describe the solution you'd like
I'd like to be able to see the type signature in the notebook instead of having to browse the docs to find them.
Describe alternatives you've considered
Additional context
Screenshot:
The text was updated successfully, but these errors were encountered: