Skip to content

refactor: rename describe property to description for cli-flags #2953

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

Merged
merged 2 commits into from
Jan 4, 2021
Merged

refactor: rename describe property to description for cli-flags #2953

merged 2 commits into from
Jan 4, 2021

Conversation

snitin315
Copy link
Member

@snitin315 snitin315 commented Jan 1, 2021

  • This is a bugfix
  • This is a feature
  • This is a code refactor
  • This is a test update
  • This is a docs update
  • This is a metadata update

For Bugs and Features; did you add new tests?

no

Motivation / Use-Case

need use description instead of describe because webpack and webpack-cli both uses description property for options.

This is helpful in the webpack --help output.

https://github.com/webpack/webpack-cli/blob/4dc1a05046aeaf5a17de878a9e595697852bcd32/packages/webpack-cli/lib/webpack-cli.js#L139-L141

Breaking Changes

no

Additional Info

no

@codecov
Copy link

codecov bot commented Jan 1, 2021

Codecov Report

Merging #2953 (f7035c8) into master (2dd1093) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2953   +/-   ##
=======================================
  Coverage   92.39%   92.39%           
=======================================
  Files          37       37           
  Lines        1263     1263           
  Branches      328      328           
=======================================
  Hits         1167     1167           
  Misses         91       91           
  Partials        5        5           

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 2dd1093...f7035c8. Read the comment docs.

Copy link
Member

@hiroppy hiroppy left a comment

Choose a reason for hiding this comment

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

I think this refactoring is not necessary /cc @alexander-akait

@snitin315
Copy link
Member Author

@alexander-akait
Copy link
Member

@hiroppy we need fix it, because webpack (inside core) uses description for options, so I think it is good fix

@hiroppy
Copy link
Member

hiroppy commented Jan 3, 2021

Yeah, I see but I didn't understand this context at first so please update the description. The current description of this PR is bad.

@snitin315
Copy link
Member Author

Yeah, I should have used a better description. Updated 👍🏻

@snitin315 snitin315 changed the title refactor: use description for cli-flags refactor: rename describe property to description for cli-flags Jan 4, 2021
@alexander-akait alexander-akait merged commit 9e3a481 into webpack:master Jan 4, 2021
@snitin315 snitin315 deleted the refactor/cli-flags branch January 4, 2021 15:20
@snitin315
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants