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

Check documentation on all files #11

Closed
ilent2 opened this issue Apr 6, 2018 · 4 comments
Closed

Check documentation on all files #11

ilent2 opened this issue Apr 6, 2018 · 4 comments
Labels
doc Documentation

Comments

@ilent2
Copy link
Owner

ilent2 commented Apr 6, 2018

  • Make usage consistent across all files
  • Function names should be in bold
  • Class names should match class declaration
  • Classes should have list of methods and properties
  • PACKAGE_INFO should be replaced by the following text

% This file is part of the optical tweezers toolbox. % See LICENSE.md for information about using/distributing this file.

@ilent2 ilent2 added the doc Documentation label Apr 6, 2018
@ilent2 ilent2 added this to To do in Version 1.5.0 via automation Apr 6, 2018
@ilent2 ilent2 added this to Done in Version 1.3.1 Apr 6, 2018
@ilent2 ilent2 moved this from Done to To do in Version 1.3.1 Apr 6, 2018
@ilent2
Copy link
Owner Author

ilent2 commented Apr 9, 2018

Example of a file with ok documentation: ott-toolbox/xyz2rtp.m

@ilent2
Copy link
Owner Author

ilent2 commented Apr 10, 2018

I'm about half way through checking the documentation of files now.

@ilent2
Copy link
Owner Author

ilent2 commented Apr 10, 2018

@AStilg, could you take a look at the documentation for sbesselh, sbesselh2 and sbesselh1, spharm. Everything else should be mostly done. I think we are probably about ready for release.

@ilent2
Copy link
Owner Author

ilent2 commented Apr 10, 2018

Done in 70202a1

@ilent2 ilent2 closed this as completed Apr 10, 2018
Version 1.5.0 automation moved this from To do to Done Apr 10, 2018
Version 1.3.1 automation moved this from To do to Done Apr 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
Version 1.5.0
  
Done
Version 1.3.1
  
Done
Development

No branches or pull requests

1 participant