search

bodleian / archiox-mirador-plugin

An experimental plugin to display depth information captured with Lucida or Selene scanners from FactumARTE. However, the plug-in can present any normal map/albedo map combination produced from any technique.
MIT License
1 stars 0 forks source link

Docstrings needed #1

Closed BeebBenjamin closed 1 year ago

BeebBenjamin commented 2 years ago

The functions need documenting with docstrings so that people can understand how functions work and why they exist

BeebBenjamin commented 1 year ago

The helper functions have been documented. Unsure if we should document the react classes, they don't do that in Mirador Image Tools @irv

irv commented 1 year ago

Nobody has ever complained that there's too much documentation

BeebBenjamin commented 1 year ago

Good point, I have however complained about a lack of Miradro plug-in docs.

BeebBenjamin commented 1 year ago

Fixed.