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

Consider adding formal api documentation comments #43

Closed
yochannah opened this Issue Jun 21, 2018 · 3 comments

Comments

Projects
None yet
2 participants
@yochannah
Copy link
Collaborator

yochannah commented Jun 21, 2018

The code is generally neat, tidy, and readable, but it might be nice to add some js api docs if possible too - it requires structured comments on functions.

See https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md for an example - it's ok to consider other documentation tools if they suit you better though.

@AdrianBZG AdrianBZG added this to the Milestone 2 (July 9) milestone Jul 4, 2018

AdrianBZG added a commit that referenced this issue Jul 4, 2018

AdrianBZG added a commit that referenced this issue Jul 4, 2018

@AdrianBZG

This comment has been minimized.

Copy link
Owner

AdrianBZG commented Jul 4, 2018

@yochannah @rachellyne The code is now documented according to documentation.js, also a new gulp task to generate the documentation for the code in src/ and place it as HTML in the docs/ folder has been made available (gulp documentation). Also the documentation is available in GitHub pages at https://adrianbzg.github.io/InterMine-Data-Browser-Tool/. 👍

image

@AdrianBZG AdrianBZG closed this Jul 4, 2018

@yochannah

This comment has been minimized.

Copy link
Collaborator Author

yochannah commented Jul 5, 2018

This is great - thanks for adding it :) I am not at all worried about picking up this code in the future - it's so well documented it should hopefully be quite easy.

@AdrianBZG

This comment has been minimized.

Copy link
Owner

AdrianBZG commented Jul 5, 2018

@yochannah Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.