Skip to content
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

chore: CKB Text Optimization #4250

Merged
merged 3 commits into from
Dec 8, 2023

Conversation

EthanYuan
Copy link
Collaborator

What problem does this PR solve?

Problem Summary:

CKB, being an executable program, produces a wide array of output messages during its runtime. These messages include console printouts, logs, error notifications, and text displayed within subcommands. These texts are authored by different developers at different stages of the development process, resulting in variations in language style and the possibility of syntax errors.

So, it is necessary to conduct an overall text review and optimization.

What is changed and how it works?

What's Changed:

We performed text extraction and editing based on revision 5975fda. Our professional writer has helped revise the text with existing issues. Many thanks to @linnnsss for the editing.

We utilized the text optimizer tool provided by #4189 to collect and format the text for organization. This made it possible for the writer to review. After the writer's editing, we employed the same tool for backfilling, resulting in the creation of this PR.

Related changes

Check List

Tests

  • No code ci-runs-only: [ quick_checks,linters ]

Release note

Title Only: Include only the PR title in the release note.

@EthanYuan EthanYuan requested a review from a team as a code owner November 28, 2023 15:31
@EthanYuan EthanYuan requested review from zhangsoledad, doitian, chenyukang and eval-exec and removed request for a team November 28, 2023 15:31
@EthanYuan EthanYuan self-assigned this Nov 28, 2023
network/src/network.rs Outdated Show resolved Hide resolved
@EthanYuan
Copy link
Collaborator Author

The text extracted and modified falls into 4 categories, each saved in:

  • thiserror_text_list.yml
  • clap_text_list.yml
  • log_text_list.yml
  • std_output_text_list.yml

They are packaged into a zip file and archived under this PR:

revised_text_files.zip

@zhangsoledad zhangsoledad added this pull request to the merge queue Dec 8, 2023
Merged via the queue into nervosnetwork:develop with commit a00ba13 Dec 8, 2023
32 checks passed
@EthanYuan EthanYuan deleted the text-optimize branch December 15, 2023 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants