Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix model update add documentation (#1) #438

Merged
merged 2 commits into from
Oct 15, 2018
Merged

Fix model update add documentation (#1) #438

merged 2 commits into from
Oct 15, 2018

Conversation

pkonneker
Copy link
Contributor

@pkonneker pkonneker commented Oct 11, 2018

  • Add is performed only on set/number

Summary:

Updated documentation for Model.update to better reflect what $ADD actually does.

GitHub linked issue:

Closes #388

Type (select 1):

  • Bug fix
  • Feature implementation
  • Documentation improvement
  • Testing improvement
  • Test added to report bug (GitHub issue #--- @---)
  • Something not listed here

Is this a breaking change? (select 1):

  • 🚨 YES 🚨
  • No
  • I'm not sure

Is this ready to be merged into Dynamoose? (select 1):

  • Yes
  • No

Are all the tests currently passing on this PR? (select 1):

  • Yes
  • No

Other:

  • I have searched through the GitHub pull requests to ensure this PR has not already been submitted
  • I have updated the Dynamoose documentation (if required) given the changes I made
  • I have added/updated the Dynamoose test cases (if required) given the changes I made
  • I have run npm test from the root of the project directory to ensure all tests continue to pass
  • I agree that all changes made in this pull request may be distributed and are made available in accordance with the Dynamoose license
  • All of my commits and commit messages are detailed, explain what changes were made, and are easy to follow and understand
  • I have confirmed that all my code changes are indented properly using 2 spaces
  • I have filled out all fields above

* Add is performed only on set/number
@coveralls
Copy link

coveralls commented Oct 11, 2018

Pull Request Test Coverage Report for Build 674

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 84.566%

Totals Coverage Status
Change from base Build 669: 0.0%
Covered Lines: 1866
Relevant Lines: 2132

💛 - Coveralls

@fishcharlie
Copy link
Member

@pkonneker Thanks for this! Will get merged in soon.

Copy link
Member

@fishcharlie fishcharlie left a comment

Choose a reason for hiding this comment

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

LGTM

@fishcharlie fishcharlie mentioned this pull request Oct 15, 2018
@fishcharlie fishcharlie merged commit 416cf23 into dynamoose:master Oct 15, 2018
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Model.update ADD only works for Number type
3 participants