[Feat] Pass whole chapter for translation #41
Merged
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
astonzhang
reviewed
Jan 8, 2022
There was a problem hiding this comment.
- When adding new features, please be careful about all relevant dependencies, such as modifying line 12:
parser.add_argument('filename', nargs='+', help='the markdown files to activate') - Be consistent in variable names, such as
chapter_dir-> chap_dir,all_ch_sections-> all_chap_sections - Use meaningful variable names to improve readability. In just a few weeks, it would probably take you time to figure out what
os.path.join(fn, file)means :) Making code more readable will eventually pay off - Although the existing code base does not always follow best practices, let's try to enforce it whenever we can, such as adding more comments and keeping each line <= 80 chars.
Last, please consider adding example use cases with inputs and expected outputs in this PR. It is like describing your proposed new feature. It will also remind you of your current assumptions/expectations (e.g., assuming md files only, not other extensions), which may be helpful for troubleshooting in the future.
AnirudhDagar
commented
Jan 10, 2022
astonzhang
reviewed
Jan 10, 2022
|
It looks good to me. @astonzhang @AnirudhDagar |
astonzhang
approved these changes
Jan 12, 2022
| @@ -9,14 +9,28 @@ | |||
|
|
|||
| def translate(): | |||
| parser = argparse.ArgumentParser(description='Translate to another language') | |||
| parser.add_argument('filename', nargs='+', help='the markdown files to activate') | |||
| # Example usage: d2lbook translate --commit 35a64ab chapter_optimization chapter_computer-vision/anchor.md | |||
| parser.add_argument('source', nargs='+', help='chapter dirs or markdown files to activate') | |||
| if sec_name.endswith(".md"): | ||
| trans.translate(os.path.join(source, sec_name)) | ||
| else: | ||
| logging.error(f'Invalid Directory {source}: Please provide' |
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.
This PR adds the ability to pass a whole chapter name instead of passing single sections for translation.
Note that #40 needs to be merged before this works correctly.
Example Use Case:
d2lbook translate --commit 35a64ab chapter_optimization chapter_computer-vision/anchor.mdThis will translate all sections in chapter optimization and only the anchor section in chapter computer vision.