AcademySoftwareFoundation/openexr

Fix table formatting in OpenEXRFileLayout.rst

Open

#1,546 opened on Sep 11, 2023

View on GitHubContributor guide
 (0 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

Two tables currently implemented as grid tables should be converted to list-table, which handles left-justification of text:

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
Follow the 'Building the Website' instructions to set up the Sphinx documentation build locally. Then locate the two grid tables in the OpenEXRFileLayout.rst file (refer to the links in the issue) and replace them with list table syntax. Use existing list table examples in the same file as a reference. Build the documentation to verify the formatting is correct left justified.
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.
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.
Clear
Prerequisites
reStructuredTextSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90