-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] ocrd-tool: change structure of in/output_file_grp param to array of objects #121
Conversation
default: | ||
type: string | ||
pattern: '^OCR-D-[A-Z0-9-]+$' | ||
description: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we get a description
for the items/properties/description
please? (Something explaining that implementors should describe their expected configurations, perhaps giving examples.)
default: | ||
type: string | ||
pattern: '^OCR-D-[A-Z0-9-]+$' | ||
description: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as for input_file_grp
description: | ||
type: string | ||
input_file_grp: | ||
description: Input fileGrp@USE this tool expects by default |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a short comment on why the array type, i.e. multiple inputs / outputs and expected ordering is due here.
Adding this to the specs would be a breaking change and would require a new major version of spec, core and all processors. Since we're moving away from separate output file groups for PAGE-XML and AlternativeImages anyway and default values for file groups rarely make sense for general use, the gain in expressiveness is not worth the problems. Closing. The comments on better documentation of the ocrd-tool.json have merit though, tracking in #157. |
c.f. #117