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

Support a TYPEDEF-like string for automatic documentation of mtkmodels ? #2675

Open
BambOoxX opened this issue Apr 20, 2024 · 1 comment
Open

Comments

@BambOoxX
Copy link

Is your feature request related to a problem? Please describe.

Currently, if one wants to document a custom component obtained using @mtkmodel, everything must be written by hand, in order to provide potential users with the proper arguments for the block.
However, one a instance of the block is created, plenty of information is available, yet the specifics are the one of the instance, not of the type.

Describe the solution you’d like

Ideally, I would like to be able to provide all the information about parameters, structural_parameters, ... automatically, since I'm pretty sure everything could be recovered by the @mtkmodel macro, leveraging description and other fields.
This looks much like $TYPEDEF from DocStringExtensions, but that doesn't seem to work on @mtkmodels.
I figured this functionality is not already available since there is no evidence of this in the standard library blocks.
Such an approach would be far much safer and easier for any developper or user.

@ChrisRackauckas
Copy link
Member

This would be a nice feature to have. I wouldn't be opposed to it, just someone needs to implement it.

Moving to ModelingToolkit.jl itself because it's not a standard library feature but rather it's something about the core macro.

@ChrisRackauckas ChrisRackauckas transferred this issue from SciML/ModelingToolkitStandardLibrary.jl Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants