search

yeatmanlab / AFQ-Browser

Browser-based visualization tools for AFQ results
BSD 3-Clause "New" or "Revised" License
33 stars 15 forks source link

Rename 3d-brain.js to anatomy.js and add docstrings to afqb functions #226

Closed richford closed 6 years ago

richford commented 6 years ago

This PR also moves all third-party js files into js/third-party.

richford commented 6 years ago

Will do save-settings.js documentation in a separate PR. I wanted to get this up here and merged quickly so that the file name changes don't disrupt other people's work too much.

richford commented 6 years ago

Nevermind. Just pushed up the save-settings docstrings as well.

richford commented 6 years ago

@anotherjoshsmith, did I format these correctly to integrate with your changes to sphinx?

anotherjoshsmith commented 6 years ago

@richford Looks like the only issue is how the list is rendered for afqb.three.init(). Here's how it looks now:

jsdoc-rendering

Adding an empty line after line 183 in anatomy.js should fix this. I see the same issue for afqb.global.initSettings. Everything else looks good!

richford commented 6 years ago

Thanks @anotherjoshsmith. Good catch. Fixed.

anotherjoshsmith commented 6 years ago

Great, looks good! Merging now.