Fix incorrect docstring for promote-certain-elements-to-title feature #1057
Conversation
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
karanataryn
reviewed
Dec 5, 2024
| a title. | ||
| Here is an example set of output label options: | ||
| {"promote_title": True, "title_candidate_elements": ["Section-header", "Caption"]} | ||
| default: None (no elements are promoted to titles) |
There was a problem hiding this comment.
Default- promote_title: False? None seems harder to grok.
There was a problem hiding this comment.
Are you suggesting we change the default value of output_label_options? It's default value is currently None - which is effectively {"promote_title": False}, but we error when promote_title is specified and title_candidate_elements is not specified, and the implementation actually uses a None, not a {"promote_title": False}.
There was a problem hiding this comment.
Discussed offline, will resolve in a follow up
karanataryn
approved these changes
Dec 5, 2024
| a title. | ||
| Here is an example set of output label options: | ||
| {"promote_title": True, "title_candidate_elements": ["Section-header", "Caption"]} | ||
| default: None (no elements are promoted to titles) |
There was a problem hiding this comment.
Discussed offline, will resolve in a follow up
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.