-
-
Notifications
You must be signed in to change notification settings - Fork 696
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
Add .length(value) deprecation warning to documentation #429
Add .length(value) deprecation warning to documentation #429
Conversation
@@ -1847,16 +1847,59 @@ module.exports = function (chai, _) { | |||
Assertion.addMethod('haveOwnProperty', assertOwnProperty); | |||
|
|||
/** | |||
* ### .length(value) | |||
* ### .ownPropertyDescriptor(name[, descriptor[, message]]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The built source seems to create a funky diff — I haven't touched the ownPropertyDescriptor
matcher at all.
Sorry @valscion - I should have mentioned you don't need to update chai.js - it will be updated as part of the release cycle. Could you pretty please remove it from the commit? |
@@ -956,8 +950,25 @@ module.exports = function (chai, _) { | |||
* expect('foo').to.have.length.within(2,4); | |||
* expect([ 1, 2, 3 ]).to.have.length.within(2,4); | |||
* | |||
* *Deprecatin notice:* Using `length` as an assertion will be deprecated | |||
* in version 2.2.1 and removed in 2.3. Code using the old style of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Next release will be 2.3.0
, and we'll have to remove it in 3.0.0
to keep semver. So could you please change this message to:
* *Deprecation notice:* Using `length` as an assertion will be deprecated
* in version 2.3.0 and removed in 3.0.0. Code using the old style of
(Also you had a typo in Depricatin
(sic))
21cf438
to
2330d93
Compare
Ah, it wasn't so clear based on As for the deprecation notice text, I changed them to what you suggested. |
Hey @keithamus, is everything OK now? |
Sorry @valscion this one slipped by me. Version is a number out now, but I'll fix that as it's my bad. All looks good, thanks for your hard work 😄. |
…ngth Add .length(value) deprecation warning to documentation
Fixes #427