Updated documentation Specifying types for GradingPrimary attributes #1640

Open sumana-2705 opened this issue 1 year ago • 1 comments

Updated Documentation: Specify Types for GradingPrimary Attributes

Description:

This pull request updates the documentation for the GradingPrimary class in OpenColorIO to specify the expected types for its attributes, enhancing clarity for developers mentioned in the issue #1640

Changes Made: Added type specifications for the following attributes:

brightness: GradingRGBM
clampBlack: float
clampWhite: float
contrast: GradingRGBM
exposure: GradingRGBM
gain: GradingRGBM
gamma: GradingRGBM
lift: GradingRGBM
offset: GradingRGBM
pivot: float
saturation: float

Jul 01 '24 12:07 sumana-2705

The committers listed above are authorized under a signed CLA.

:white_check_mark: login: sumana-2705 / name: Sumana Sree (0b3f7370d8649bcf734e4b4303341313ed906037, bbf0c7b36475f502d13c54cde4f668088e0e83ea, c5f88f89a22fd0074b051209f182ac4650a4a899)
:white_check_mark: login: doug-walker / name: Doug Walker (bc3a050915032554101e6cbad723b31f54cbf48a)

Jul 01 '24 12:07 linux-foundation-easycla[bot]

While I was running initial tests mentioned in the issue, it did not mention pivotWhite and pivotBlack, which is why they were not included in my first response. However, considering your feedback, I think it is reasonable to assume that these properties also follow the pattern observed for similar properties like pivot. If that's not the case, please let me know.

Jul 23 '24 08:07 sumana-2705