Closed RFSH closed 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.
Add a "Features" section and have the sections that you're explaining the features under it.
"Ask where to mention about different annotation for each index and channel configuration": In the "Click on a Z index" you should also mention that new image annotations will be fetched.
Having some level of implementation details in the "features" section is fine, but not too much. For example the appendData
and ResizeSensor
that you explained should go to implementation details. Your implementation details doesn't have any actual "detail".
Implementation details: Instead of explaining all osd viewer in one section and chaise in another, explain them in order that they are running. So chaise will first fetch the required data for the main image and also number of z-indexes here and then here is where we're telling the z-plane-list.js to initialize and it will call the init
function. And then init
will ask chaise to fetchZPlaneListByZIndex
, etc
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 calleddev-docs
. And then add a newmulti-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.