sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
http://sphinxcontrib-matlabdomain.readthedocs.io/
Other
69 stars 45 forks source link

Ignore comments while parsing base classes. #173

Closed rdzman closed 1 year ago

rdzman commented 1 year ago

Fix #172.

joeced commented 1 year ago

Thanks for the contribution. It would be great if you would try to add a test case for it.

In this case I would add a class (or two) in tests/test_data, for instance named

In tests/test_parse_mfile.py you then add a testcase for that file, checking that the base classes, docstrings are correct. Lastly, you need to add the new class(es) to the "catch-all" module test test_module in tests/test_matlabify.py.

rdzman commented 1 year ago

I've added the tests as you requested. Thanks for the detailed instructions.

Without the patch we now have failures and with the patch everything is passing.