Skip to content

Remove the requirement labels from meta-inf file intro descriptions - #3111

Merged
mattgarrish merged 1 commit into
mainfrom
editorial/meta-inf-req
Nov 12, 2026
Merged

mattgarrish merged 1 commit into
mainfrom
editorial/meta-inf-req

Conversation

@mattgarrish

@mattgarrish mattgarrish commented Nov 12, 2026 •

Copy link
Copy Markdown
Member

This is more of a minor nit on my part, but since we're doing some cleanup in these sections...

Having [required] and [optional] labels after each file name in the introduction makes the section look like our normative content models. The paragraph under the descriptions already says to refer to the file descriptions for usage info and each file's description normatively states whether it is required or optional. Nothing is lost by removing these labels except the appearance that they are normative.


Preview | Diff

@iherman

iherman commented Nov 12, 2026

Copy link
Copy Markdown
Member

I agree.

However, while we are it: this intro section is fairly far away from the sections that really describe/define them normatively. Sections 4.2.2-4.2.5 are entirely devoted to the gory details of file systems, base URLs etc. These sections are also very long. One would expect 4.2.6 to follow the introductory section, and it is not the case. I wonder whether a restructuring of the sections would make sense: something about file system and base URL details in 4.2 and the META-INF directory (with the sections you just changed).

I guess this PR should be merged but it may be worth thinking about reordering.

@mattgarrish

Copy link
Copy Markdown
Member Author

Ya, most of the abstract container intro reads as an intro to the meta-inf directory. We could take all of that text and make it an intro under 4.2.6, or possibly even merge it normatively into 4.2.6.1

But then what's left of the intro would need some additions to flesh it out. I'll merge this since it's pretty non-controversial and take a stab at fixing the section ups some more.

@mattgarrish
mattgarrish merged commit c559a0b into main Nov 12, 2026
2 checks passed
@mattgarrish
mattgarrish deleted the editorial/meta-inf-req branch November 12, 2026 18:00
@github-project-automation github-project-automation Bot moved this from In review to Done in PM/EPUB issues Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants