search

janklab / MatlabProjectTemplate

A template for creating repos for Matlab library and application projects
BSD 3-Clause "New" or "Revised" License
12 stars 1 forks source link

Best Practices for MATLAB Toolbox Development #32

Open rpurser47 opened 1 year ago

rpurser47 commented 1 year ago

Hi Andrew, Sorry to open an issue on you, I didn't see another way to reach out to you.

I wanted to make you aware of a new resource MathWorks has created for MATLAB Toolbox Authors: Best Practices for MATLAB Toolbox Development." Check it out now!

This comprehensive guide provides valuable guidelines and recommendations for high-quality and user-friendly MATLAB toolboxes. By following these best practices, you can create toolboxes that enhance productivity and deliver an exceptional user experience. We also have included a complete example (link) that implements all the best practices.

This has been released under a permissive license so that people can redistribute them freely and incorporate them in their own organization’s best practices. If you have comments or suggestions, open an issue or participate in the discussions on GitHub.

Check out our guide today and start building exceptional MATLAB toolboxes! https://github.com/mathworks/toolboxdesign

All the best, -@rpurser47

apjanke commented 1 year ago

That looks awesome; thanks Rob! (The Discord is excited about this thing too.) I will give it a read through and see about incorporating its guidance here.

You can also reach me by email at andrew@apjanke.net or any of the contact methods listed on https://apjanke.net/.

apjanke commented 1 year ago

BTW, if you have spare time, have a look at https://github.com/janklab/MlxShake which is my take on using LiveScripts to publish "rich" documentation suitable for inclusion in a distributed Matlab library or toolbox, which might be relevant here.

I should have some time to read through this Best Practices thing over the weekend and get back to you early next week on it.

rpurser47 commented 1 year ago

Nice -- I use Michio's livescript2markdown all the time, so it's great to see a derivative of it. Should you decide to refactor to follow the best practice, I would be very interested in your take on how that process goes, and the (hopeful) benefits!