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

Header in functions #269

Open
Lychfindel opened this issue Oct 4, 2024 · 2 comments
Open

Header in functions #269

Lychfindel opened this issue Oct 4, 2024 · 2 comments

Comments

@Lychfindel
Copy link

Hi,
I'm writing a matlab package where the docstring of the functions is written as header file, like EEGLAB style.
I saw that the current code automatically remove the header comments of the functions, but it keeps the header as docstring for the scripts.
I think it would be useful to add the option of having the docstring of the function as header. I don't know if the best option would be to make optional the removal of header docstring, or it might be considered as docstring only if the header starts with "%% functionName"

@apozharski
Copy link
Collaborator

Hello,
This is indeed definitely possible (perhaps even easy) to add as an option. I have mild concerns with the maintainability of supporting a wide range of formats e.g. what would be required for #140 which I plan on working on in the near future. I will probably combine this in with that work.

@Lychfindel
Copy link
Author

Hi,
thanks for the reply!
If you need some help I would be happy to contribute, I just need some hints on how the code is parsed because from the code I don't understand where header comments are removed in functions and where instead they are kept in scripts.

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