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

Rename --version to --electron-version #154

Closed
malept opened this issue Oct 12, 2015 · 3 comments
Closed

Rename --version to --electron-version #154

malept opened this issue Oct 12, 2015 · 3 comments

Comments

@malept
Copy link
Member

malept commented Oct 12, 2015

There seem to be a disproportionate number of issues created over the confusion around what --version actually means. (See: #137, #140, #153.) I propose that the parameter be renamed so that it's obvious as to what the flag's value refers to: the version of Electron, not the version of the application.

This would obviously be a breaking change, requiring a major version bump.

@max-mapper
Copy link
Contributor

I'd rather try and fix this with docs first. The readme formatting could use some love, e.g. the usage section is currently a big wall of unicode text

@malept
Copy link
Member Author

malept commented Oct 12, 2015

I figured as much. I just wanted to get this idea out there and documented.

I'll take a crack at making the README friendlier tonight, if I have some time.

Closing for now.

@malept malept closed this as completed Oct 12, 2015
@malept
Copy link
Member Author

malept commented Sep 3, 2016

I'm reopening this. No amount of docs has fixed this so far. In my opinion, this option violates the principle of least astonishment.

Here's the specification for how this should work:

  1. Write a pull request to add electronVersion to the API, and --electron-version to the CLI arguments. Deprecate the --version argument. Make it really clear in the docs and when it's used (instead of electronVersion) that the --version argument is deprecated.
  2. Maintainer releases a minor version with this change.
  3. Write a pull request to remove --version and associated deprecation warnings.
  4. Maintainer releases a major version with this change.

@malept malept reopened this Sep 3, 2016
@malept malept changed the title [RFC] Rename --version to --electron-version Rename --version to --electron-version Sep 3, 2016
@malept malept added bug 🐛 help wanted Needs a contributor from the community labels Nov 2, 2016
@malept malept removed the help wanted Needs a contributor from the community label Jan 3, 2017
@malept malept self-assigned this Jan 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants