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

Adding docs for clean #260

Closed
wants to merge 2 commits into from
Closed

Adding docs for clean #260

wants to merge 2 commits into from

Conversation

C45tr0
Copy link
Contributor

@C45tr0 C45tr0 commented Nov 1, 2018

This is just adding docs in the README for clean.

Resolves #134

@coveralls
Copy link

Coverage Status

Coverage remained the same at 98.826% when pulling 8a92851 on C45tr0:setup-clean-docs into 6086e5a on npm:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 98.826% when pulling 8a92851 on C45tr0:setup-clean-docs into 6086e5a on npm:master.

@coveralls
Copy link

coveralls commented Nov 1, 2018

Coverage Status

Coverage remained the same at 98.826% when pulling fbcd382 on C45tr0:setup-clean-docs into 6086e5a on npm:master.

README.md Outdated

ex.
* `s.clean(' = v 2.1.5foo')`: `null`
* `s.clean(' = v 2.1.5foo', true)`: `'2.1.5-foo'`
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be s.clean(' = v 2.1.5foo', { loose: true }) now. The boolean option has been replaced with an options object.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both spots have been updated.

@isaacs isaacs closed this in 1aaf078 May 22, 2019
stabbylambda pushed a commit to stabbylambda/node-semver that referenced this pull request Nov 18, 2019
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.

README lacks documentation on clean() function
4 participants