Skip to content

Describe generation more clearly#212

Merged
samdbmg merged 4 commits into
mainfrom
sammg_docs_clearer-flow-generation
Jun 10, 2026
Merged

Describe generation more clearly#212
samdbmg merged 4 commits into
mainfrom
sammg_docs_clearer-flow-generation

Conversation

@samdbmg

@samdbmg samdbmg commented May 28, 2026

Copy link
Copy Markdown
Member

Details

  • Make clearer that generation is a relative value used to sort which Flows have been through more lossy encodings.
  • Amends examples accordingly.
  • Fixes some examples that describe impossible situations

Issue (if relevant)

GitHub Issue: Fixes #204

Also tracked as https://jira.dev.bbc.co.uk/browse/CLOUDFIT-5540

Related PRs

N/A

Submitter PR Checks

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Jira Issue (if relevant)
  • Follow-up stories added to Jira

Reviewer PR Checks

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

samdbmg added 3 commits May 28, 2026 16:55
Consistently applies the guidance that `generation=0` means that no
higher quality will become available - so H.264 video et al cannot be
generation 0.
Fixes some examples where the Flow or Source IDs appear elsewhere, or
the example represents an impossible situation.
@samdbmg samdbmg requested a review from a team as a code owner May 28, 2026 15:55

@j616 j616 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nit. Otherwise LGTM

Comment thread api/schemas/flow-core.json Outdated
Co-authored-by: James Sandford <james.sandford@bbc.co.uk>
@samdbmg samdbmg force-pushed the sammg_docs_clearer-flow-generation branch from 1a6306c to 92d9d83 Compare June 10, 2026 14:21
@samdbmg samdbmg merged commit b999dc9 into main Jun 10, 2026
8 checks passed
@samdbmg samdbmg deleted the sammg_docs_clearer-flow-generation branch June 10, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Flow Generation field to make clear it's fairly easy to set

2 participants