docs: ✨ doc update #661
Draft
docs: ✨ doc update #661
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
add API usage example with custom prompt.
if config save null, it will save `NULL`. When get the key, `NULL` will ignore and read the environment and the default value.
|
@awwaawwa 确认一下config这个逻辑合理不。 |
TMT with config miss env which lead to fail to translate.
There was a problem hiding this comment.
PR Overview
This pull request updates the documentation with a new API usage example featuring a custom prompt and adjusts code to support dynamic font URLs and regional configuration.
- Refactors font download logic to use a dynamic URL from the configuration and adds progress reporting.
- Introduces a new command-line argument (--CN) to toggle regional settings and update environment variables.
- Updates API and advanced documentation with instructions for custom prompt usage and Docker configuration, and adjusts translator classes to include an "iskey" attribute.
Reviewed Changes
| File | Description |
|---|---|
| pdf2zh/high_level.py | Refactors font download logic to use a configurable URL and provides progress UI. |
| pdf2zh/pdf2zh.py | Adds a new "--CN" argument and reorders configuration calls. |
| docs/APIS.md | Updates curl examples and adds a custom prompt usage example. |
| pdf2zh/gui.py | Dynamically sets input field type based on translator "iskey" settings. |
| docs/ADVANCED.md | Adds Docker-specific custom configuration instructions. |
| pdf2zh/translator.py | Adds "iskey" attributes with accompanying comments across translator classes. |
| README.md | Updates documentation to reference new Docker configuration guidance. |
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
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.
add API usage example with custom prompt.