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

docs: Added english doc to how-to-migrate-from-1.x #4630

Merged
merged 2 commits into from
Mar 8, 2021

Conversation

ZixiaoWang
Copy link
Contributor

Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

No core subsystem is affected.

Description of change

Added English translation to migration.md under en folder.
添加了en 文件夹下的 migration.md 英文版本。

@codecov
Copy link

codecov bot commented Mar 4, 2021

Codecov Report

Merging #4630 (d04fa70) into master (693df60) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #4630   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           34        34           
  Lines         1112      1112           
  Branches       183       183           
=========================================
  Hits          1112      1112           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 693df60...d04fa70. Read the comment docs.

@ZixiaoWang ZixiaoWang marked this pull request as draft March 5, 2021 02:17
@ZixiaoWang ZixiaoWang marked this pull request as ready for review March 5, 2021 02:17
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
- generator functions (delegation)

Use `async function` to replace the above functions, or use [app.toAsyncFunction] to wrap them if async function is not the case.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or use [app.toAsyncFunction] to wrap them if async function is not the case -> or use [app.toAsyncFunction] alternatively

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, it's been changed to or use [app.toAsyncFunction] alternatively.
But it misses the 如果不能修改 part in ZH-CN version. TBD

docs/source/en/migration.md Outdated Show resolved Hide resolved
docs/source/en/migration.md Outdated Show resolved Hide resolved
In some cases, the interface provided by `Plugin developers` supports both generator and async, normally it's wrapped by co.

- In 2.x, we suggest to change to `async-first` in order to get a better performance and clearer error stacks.
Copy link
Member

@gemwuu gemwuu Mar 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. remove to change to
  2. remove in order

Copy link
Contributor Author

@ZixiaoWang ZixiaoWang Mar 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.
I felt

we suggest to use async-first for a better performance and clearer error stacks.

could be more natural. But I'm sure either way people'll get the point.

docs/source/en/migration.md Outdated Show resolved Hide resolved
Copy link
Member

@gemwuu gemwuu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this PR, please resolve the issues when available

@ZixiaoWang
Copy link
Contributor Author

Did an extra checking, updated all the places accordingly, and also corrected a few undiscovered spelling mistakes.
Replaced a few words with more nature ones, upgradation -> upgrade for example.

Thank you very very much for pointing out mistakes! 🙏

@gemwuu gemwuu changed the title Added english doc to how-to-migrate-from-1.x docs: Added english doc to how-to-migrate-from-1.x Mar 6, 2021
Copy link
Member

@gemwuu gemwuu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gemwuu
Copy link
Member

gemwuu commented Mar 6, 2021

@atian25

@gemwuu gemwuu merged commit 603c74b into eggjs:master Mar 8, 2021
popomore pushed a commit that referenced this pull request Mar 8, 2021
docs: Added english doc to how-to-migrate-from-1.x (#4630)

* Added english doc to how-to-migrate-from-1.x

* Corrected typos and some other spelling errors, polished grammar accordingly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants