search

quintusdias / glymur

Python interface to OpenJPEG library for reading and writing JPEG 2000 images.
MIT License
58 stars 24 forks source link

Add API reference to docs #623

Closed dstansby closed 9 months ago

dstansby commented 11 months ago

I often find myself looking into the source code for Jp2k to work out what the different parameters etc. mean. I thought it might be helpful to add an API reference page to the docs to make this information more discoverable.

quintusdias commented 11 months ago

Hi David, it's certainly a good idea... Another issue I have open that is similar was to investigate a refactoring of the Jp2k class to at least split off reading JPEG 2000 from writing JPEG 2000 (the documentation for reading becomes much simpler), but I'm not happy with how that is looking at the moment.

I may end up manually pulling your PR into the devel branch and going from there. Need to think about this for a bit.