AcademySoftwareFoundation/openexr

Fix formatting of sample exr file in OpenEXRFileLayout.rst

Open

#1,545 opened on Sep 11, 2023

View on GitHubContributor guide
 (12 comments) (0 reactions) (0 assignees)C (695 forks)auto 404
Documentationgood first issuehelp wanted

Repository metrics

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

Description

The formatting here is confusing and hard to read: https://openexr.com/en/latest/OpenEXRFileLayout.html#sample-file

The table show simply annotate each byte of the file, alongside the hex value of the byte. The formatting would probably work better as a single long column.

This task requires some basic familiarity with reStructuredText and sphinx but the concepts are easy to pick up from other examples. See Building the Website for how to test the formatting.

Contributor guide

Research direction
Review the current formatting of the table in OpenEXRFileLayout.rst, edit it to a single column format, and rebuild the documentation using the instructions in Building the Website to verify the change.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
GitreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80