pedrocr / rawloader

rust library to extract the raw data and some metadata from digital camera images
GNU Lesser General Public License v2.1
304 stars 53 forks source link

Tweak documentation for RawImage::data #24

Closed eyeplum closed 4 years ago

eyeplum commented 4 years ago

Previously the asterisks (*) in the comments of RawImage::data was incorrectly interpreted as formatting characters by docs.rs, making the documentation for this field confusing to read.

It has been fixed by adding escaping before asterisks. Also tweaked formats of other mentioned fields in the comments to make them more obvious.

eyeplum commented 4 years ago

Before:

has widthheightcpp elements

After:

has width*height*cpp elements

michalfita commented 4 years ago

Language wise, * isn't proper multiplication character, but × is...

pedrocr commented 4 years ago

Thanks for the fix!