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 columns to helpWidth #1396

Merged
merged 1 commit into from
Nov 21, 2020

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Nov 20, 2020

Pull Request

Problem

I named the Help property which determines help wrapping columns, since the default value is process.stdout.columns or process.stderr.columns. But this does not describe what it is used for in Help or what custom implementations should be supplying. Naming it based on the purpose could make it clearer for supplying custom values.

Solution

Rename:

  • columns -> helpWidth
  • getOutColumns() -> getOutHelpWidth()
  • getErrColumns() -> getErrHelpWidth()

Release Note

This is a breaking change from the first prerelease, but does not need to appear in the final release notes.

@shadowspawn shadowspawn added this to the v7.0.0 milestone Nov 20, 2020
Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

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

That's nice!

@shadowspawn shadowspawn merged commit eac4787 into tj:release/7.x Nov 21, 2020
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Nov 21, 2020
@shadowspawn shadowspawn deleted the feature/help-width branch November 21, 2020 02:34
@shadowspawn shadowspawn mentioned this pull request Nov 21, 2020
5 tasks
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Jan 16, 2021
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.

2 participants