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

Improve documentation for the theia extensions of package.json #8976

Closed
wants to merge 0 commits into from

Conversation

zhaomenghuan
Copy link
Contributor

What it does

Improve documentation for the theia extensions of package.json

How to test

Documentation changes only

Review checklist

Reminder for reviewers

Signed-off-by: 赵梦欢 zhaomenghuan02@meituan.com

@vince-fugnitto vince-fugnitto added documentation issues related to documentation electron issues related to the electron target labels Jan 21, 2021
Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

@zhaomenghuan thank you for the contribution to improve the documentation 👍

Do you mind updating the commit title and message to be more specific regarding the changes, the current information is too generic and does not accurately describe the changes (no mention of @theia/core, electron for example).

@@ -42,6 +46,7 @@ Each extension can consist of the following modules:
- `frontendElectron` is used in the electron env
- `backend` is used in the node env and as well in the electron env if `backendElectron` is not provided
- `backendElectron` is used in the electron env
- `electronMain` is used in the electron-main env
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this statement offers much value, to an application or extension developer what is an electron-main environment, and how is it different than the standard electron environment? In addition, I do not believe electronMain is for an "electron-main env" but rather an extension point to provide customizations to the electron-main process (#7964).

Copy link
Member

Choose a reason for hiding this comment

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

is used in the electron-main process could do the trick?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation electron issues related to the electron target
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants