AcademySoftwareFoundation / AcademySoftwareFoundation/OpenCue

Document what different states mean (e.g "eaten")

Closed
#1,300 1 comment 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
957
Forks
259
Avg merge
3d 6h
Merged PRs (30d)
16

Description

**Describe the enhancement**
Being new to the OpenCue, there is a few references to "eating frames", and I couldn't work out exactly what that means (and thus things like the "Eats all dead frames for job" pacman button in the cuegui were mysterious)

Only as I write this I stumbled across the docstrings on
https://github.com/AcademySoftwareFoundation/OpenCue/blob/d2057d3f1c3c01d5a78fedd9a22fe8400d91ec83/proto/job.proto#L409-L427
which explains it nicely, "Frame is eaten, acts like the frame has succeeded" - although a little more context would be helpful (like I the state exists to allow dependent jobs to continue, unlike leaving the frames as dead?)

Would be handy to have the states this documented in the glossary or similar

**Screenshots**
~If applicable, add screenshots to help explain your suggestion.~

**Version Number**
d2057d3f1c3c01d5a78fedd9a22fe8400d91ec83

**Additional context**
~Add any other context here.~

Contributor guide

Open the contributing guide

Research direction

Start with the state docstrings in proto/job.proto around lines 409-427, then inspect the existing glossary or related documentation and the CueGUI context for the Pacman action. Document what the relevant states mean, including why eating a frame lets dependent jobs continue, and make the Pacman action understandable to newcomers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.