Addressing problems raised in sphinx_issues #10104 #61
Conversation
This file contains 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
shimizukawa
requested changes
Apr 24, 2022
There was a problem hiding this comment.
@hoangduytranuk please check my comment and update docstring (or code-comment).
| @@ -37,7 +37,7 @@ def dump_po(filename, catalog, line_width=76): | |||
|
|
|||
| # Because babel automatically encode strings, file should be open as binary mode. | |||
| with io.open(filename, 'wb') as f: | |||
| pofile.write_po(f, catalog, line_width) | |||
| pofile.write_po(f, catalog, line_width, sort_output=sort_output, sort_by_file=sort_by_message_location) | |||
There was a problem hiding this comment.
Memo
https://babel.pocoo.org/en/latest/api/messages/pofile.html#babel.messages.pofile.write_po
sort_output– whether to sort the messages in the output by msgidsort_by_file– whether to sort the messages in the output by their locations
defaults are False: sort_output=False, sort_by_file=False
| @@ -23,7 +23,7 @@ def load_po(filename): | |||
| return pofile.read_po(f, charset=charset) | |||
|
|
|||
|
|
|||
| def dump_po(filename, catalog, line_width=76): | |||
| def dump_po(filename, catalog, line_width=76, sort_output=False, sort_by_message_location=False): | |||
There was a problem hiding this comment.
Please add param lines on docstring for new 2 parameters.
These two arguments are not set to True within this tool and may be removed as unnecessary arguments. As a remedy, please describe the purpose for which they are arguments in the docstring or code comment.
UPDATED: please fix linter error.
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.
Added sort_output=False and sort_by_message_location=False so these flags can be controlled by users when dumping the po files manually and making use of the internal sort_output (sort the msgid alphabetically when writing to file) or sort_by_message_location (internally known as sort_by_file)