informatics-isi-edu / openseadragon-viewer

2D viewer with openseadragon
Apache License 2.0
5 stars 2 forks source link

Dev document for Multi-z features #75

Closed RFSH closed 3 years ago

RFSH commented 3 years ago

I left this comment for this function: https://github.com/informatics-isi-edu/openseadragon-viewer/blob/master/js/toolbar/z-plane-list.js#L135 List all the parameters of that object in there and generally the code should be well commented. So feel free to add as much as you think is necessary.

Also I think what you did for this feature is complex enough that you should create a doc for it and explain everything that you did (including what you did in chaise for the jump to z-index). Create a folder under docs folder called dev-docs. And then add a new multi-z.md file and explain what you did in there. The doc should be targeted at the developers so add as much detail as is necessary to explain the code.

The following is an example of such document:

https://github.com/informatics-isi-edu/chaise/blob/master/docs/dev-docs/flow-control.md

You can see that in there I mentioned both code and expected behavior in the UI.

RFSH commented 3 years ago

@rastogi-bhavya Overall the level of details that you have is good. I like that at first you're explaining the feature and then you're talking about implementation. You just need to organize it better.