AcademySoftwareFoundation/openexr

Fix formatting of sample exr file in OpenEXRFileLayout.rst

Ouverte

#1 545 ouverte le 11 sept. 2023

Voir sur GitHubGuide contributeur
 (12 commentaires) (0 réaction) (0 personne assignée)C (695 forks)auto 404
Documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (1 812 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Examinez le formatage actuel du tableau dans OpenEXRFileLayout.rst, modifiez le en un format à une seule colonne, puis reconstruisez la documentation en suivant les instructions de Building the Website pour vérifier le changement.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitreStructuredText
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80