AcademySoftwareFoundation/openexr

Describe new compression method API in documentation

Open

#1,859 opened on Oct 2, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)C (695 forks)auto 404
help wanted

Repository metrics

Stars
 (1,812 stars)
PR merge metrics
 (PR metrics pending)

Description

Add to https://openexr.com/en/latest/ReadingAndWritingImageFiles.html#compression, source is here.

In anticipation of future support for new compression types, there is now a convenience API for mapping between compression type names and the associated enum:

getCompressionDescriptionFromId(Compression, std::string&)
getCompressionIdFromName(const std::string&, Compression&)
getCompressionNameFromId(Compression, std::string&)
getCompressionNamesString(const std::string&, std::string&)
getCompressionNumScanlines(Compression)
isValidCompression(int)

Contributor guide

Research direction
Locate the RST source file (ReadingAndWritingImageFiles.rst) in the website directory, find the compression section, and add the new API functions with descriptions following the existing documentation pattern.
Tech stack
c
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRST
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85