Skip to content

Updated documentation Specifying types for GradingPrimary attributes #1640#1989

Merged
doug-walker merged 4 commits into
AcademySoftwareFoundation:mainfrom
sumana-2705:new_branch
Aug 9, 2024
Merged

Updated documentation Specifying types for GradingPrimary attributes #1640#1989
doug-walker merged 4 commits into
AcademySoftwareFoundation:mainfrom
sumana-2705:new_branch

Conversation

@sumana-2705
Copy link
Copy Markdown
Contributor

@sumana-2705 sumana-2705 commented Jul 1, 2024

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

Signed-off-by: sumana sree <sumanasree2705@gmail.com>
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Jul 1, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@sumana-2705 sumana-2705 changed the title Updated documentation Specifying types for GradingPrimary attributes Updated documentation Specifying types for GradingPrimary attributes #1640 Jul 1, 2024
@doug-walker doug-walker requested a review from cozdas July 22, 2024 01:24
Copy link
Copy Markdown
Collaborator

@cozdas cozdas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to include pivotWhite and pivotBlack in the list as well?

@sumana-2705
Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Collaborator

@cozdas cozdas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants