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

Change sortComparePriority contract #319

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Bob-chemist
Copy link

@Bob-chemist Bob-chemist commented Dec 23, 2019

Fixes #318

  • code is properly formatted (npm run fmt)
  • tests are updated
  • documentation is updated (npm run doc to regenerate documentation based on comments)
  • description of changes is added under the Unreleased header in CHANGELOG.md

Copy link
Member

@belochub belochub left a comment

Choose a reason for hiding this comment

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

Welcome, and thanks for the contribution.
From what I can tell right now, you haven't updated the documentation despite marking it as done in the pull request description.
Rebase on master and update the documentation, please.

test/sort.js Outdated Show resolved Hide resolved
@belochub belochub added semver-major incompatible API changes and removed compatibility enhancement labels Dec 30, 2019
@Bob-chemist
Copy link
Author

  • documentation is updated

Copy link
Member

@belochub belochub left a comment

Choose a reason for hiding this comment

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

You've changed the function signature, but you still haven't updated the documentation apart from the usage example.

CHANGELOG.md Outdated Show resolved Hide resolved
test/sort.js Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
Copy link
Member

@belochub belochub left a comment

Choose a reason for hiding this comment

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

Documentation still isn't updated according to the changes to the function's signature.

test/sort.js Outdated Show resolved Hide resolved
lib/sort.js Outdated Show resolved Hide resolved
@@ -21,19 +21,21 @@ const CONFIG_FILES_PRIORITY = [
'routes.js',
];

const compareFunction = common.sortComparePriority(CONFIG_FILES_PRIORITY);
Copy link
Member

Choose a reason for hiding this comment

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

Nit: I'd just inline the CONFIG_FILES_PRIORITY at this point.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
lib/sort.js Outdated Show resolved Hide resolved
lib/sort.js Show resolved Hide resolved
lib/sort.js Outdated Show resolved Hide resolved
lib/sort.js Outdated Show resolved Hide resolved
Copy link
Member

@belochub belochub left a comment

Choose a reason for hiding this comment

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

LGTM. Will be landed before the next major version release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-major incompatible API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change sortComparePriority contract
4 participants