feat(ingest): prompt for a description at authoring time (RM8)#91
Merged
Conversation
The ingest CLI already nudged on a missing transcript for audio/video but set only title+publisher on a record's Dublin Core, with no way to supply a description and no prompt when it was absent. Add a repeatable --description flag that populates dublin_core.description, and a non-blocking stderr advisory when a record has none: a description is what makes an item discoverable and gives a reader (including a screen-reader user) context beyond the title. Advisories stay English CLI stderr notes, matching the existing transcript and preservation advisories (no i18n catalog change). Updates the ACR 504 row and the RM8 research-roadmap entry to reflect the new authoring prompt; per-payload alt text for a future image payload type remains the open part of RM8. Tests: a title-only ingest warns 'no description'; --description silences it and persists the value on the record's Dublin Core. Signed-off-by: ChelseaKR <3114598+ChelseaKR@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this change does
Implements the remaining code portion of RM8 (authoring-time accessibility prompts). The ingest CLI already nudged on a missing transcript for audio/video, but it set only
title+publisheron a record's Dublin Core and had no way to supply a description and no prompt when one was absent.--description TEXTflag toledger ingestthat populatesdublin_core.description.ACR.md504 row and the RM8 research-roadmap entry to reflect the new authoring prompt.Why
ACR criterion 504 (Authoring Tools) was
Partially Supportsspecifically because "the CLI does not yet actively prompt an author to supply accessibility information." This closes the metadata half of that gap (transcript prompting already existed). Per-payload alt text for a future image payload type remains the open part of RM8 and is noted as such.Checklist
make verifyequivalents green locally:ruff check+ruff format --checkclean;mypyclean (57 files); fullpytestgreen (1002 passed, 2 skipped). One unrelated test (test_consent_store_write_failure_raises_without_leaking) fails only under this sandbox's root uid because it simulates a write failure viachmod 0o500, which root bypasses — it fails identically onorigin/mainwith this diff stashed, and passes on CI's non-root runner.tests/test_metadata_advisory.py— a title-only ingest warns "no description";--descriptionsilences it and persists the value.ACR.md,docs/RESEARCH-ROADMAP.md;CHANGELOG.mdunder Unreleased.Notes for reviewers
The advisory deliberately stays an English CLI stderr note, matching the two existing ingest advisories (transcript, preservation) — those are operator-facing and not routed through the gettext catalog, so no EN/ES/FR/AR translation is required here. The web browse surface (which is i18n'd) is untouched.
Generated by Claude Code