Cache Overhaul for OpenSeadragon (reviewed). #289
Conversation
There was a problem hiding this comment.
This is awesome! Thank you for putting all of this documentation together.
There are some places where there are some English grammatical oddities... Your English is excellent, but still there are some things I would change to make it read more smoothly. Perhaps I should do an editing pass to touch up some of those… seems easier than pointing them all out via review. What do you think?
Feel free to edit any content. I am well aware I have problems to come up with easily understandable text 😄 |
…e description. Rename everywhere docs page data-plugins -> data-modification.
|
Cool; I'll do a pass on this at some point. Otherwise I think it's good to go. We won't merge it until we release 6.0.0, of course. |
www/advanced-data-model.html
Outdated
| like signature). Overriding cache key generation may or might not be | ||
| necessary. | ||
| Upon data submission, you must provide a data type you submit, and | ||
| optionally provide type convertors in case your format is not supported |
There was a problem hiding this comment.
I've just noticed this (despite having seen the code before many times): the standard English spelling is "converter". Evidently "convertor" is also legal, but much less common. Perhaps we should rename the feature to align with common English spelling? Apologies for not noticing this sooner!
There was a problem hiding this comment.
Also in the whole codebase? I think variables/classes have the name too.
There was a problem hiding this comment.
Yeah, I think so. Again, apologies for not catching it sooner!
|
@iangilman I've added docs on drawer design as well, in case you want to check that out too. |
Documentation for openseadragon/openseadragon#2407