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

Autodocument arguments blocks #265

Open
XiaoCasd opened this issue Aug 31, 2024 · 2 comments
Open

Autodocument arguments blocks #265

XiaoCasd opened this issue Aug 31, 2024 · 2 comments

Comments

@XiaoCasd
Copy link

It would be helpful to auto-document the argument blocks of a function, and show the argument types, validations, and comments. For example, the following argument block in MATLAB

arguments 
   var string %It is a string
end

can be converted to a docstring

:param string var: It is a string
@joeced
Copy link
Collaborator

joeced commented Sep 2, 2024

This is partly being worked on in this branch. The PR #261 adds parsing of argument blocks. Maybe this could be a future feature.

@apozharski
Copy link
Collaborator

@XiaoCasd and anyone else interested in this feature:

With the merging of #261 into main this feature now should work (and is tested in test_parse_mfile). I am not yet ready to cut a new release as I want to write a few more tests to verify that the new parsing works correctly for the newly supported features (enumerations, argument blocks, and events) and that the output for these is correct. If you have any feedback I would be happy to hear it.

I will close this issue as completed in the next release.

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

3 participants