AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Docs Feedback
- Lingua principale
- C++
- Stelle
- 2.1k
- Fork
- 503
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Thought I would share some notes I took while deep diving the Authoring documentation:
- The reference definition in [Roles](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#roles) seems to be backwards with the Note stating that "The reference role has sometimes been misinterpreted as being the space in which “reference art” is stored in."
- The 'rendering' role definition seems to be missing. It's defined in the OpenColorIO Confluence and is present in the reference-config. Not sure if this is intentional.
- Some clarity on the config's scene_reference would be good to have. Maybe in the first paragraph of [colorspaces](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#id13)? Quoting Carol Payne's answer on Slack:
"The reference space of an ocio config is implicit - it’s the colorspace in the config all others are defined to and from, and as such doesn’t need a definition. As you noted, this has historically been the first colorspace in the list, but I don’t believe there is a code reason other than convention for this."
- I was a little confused in [family_separator](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#family-separator). It states that "If no separator is defined, the Menu Helpers API will not generate hierarchical menus." However, in the reference-config, the family_separator value is not defined and hierarchical menus are present (e.g Input/ARRI, Input/Sony, etc.) Does this mean that family_separator's default value is '/' when not defined or simply a bug?
- A link to [Authoring Configurations](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html) would be handy in [Quick Start for Config Authors](https://opencolorio.readthedocs.io/en/latest/quick_start/for_config_authors.html)
Cheers!
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con le sezioni Roles, colorspaces e family_separator della documentazione Authoring, quindi confronta le relative affermazioni con reference-config e con la pagina Quick Start for Config Authors. Il lavoro è completo quando le definizioni e il comportamento segnalati sono corretti o chiariti e viene aggiunto il link richiesto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100