[docs] Fix singIn method comment
Description of changes
Parameter password described in JSDoc did not appear in the function signature. It needed to be pw as it was defined in the method itself. This PR only adds the parameter names in the method comment.
Issue #, if available
Description of how you validated changes
Checklist
- [x] PR description included
- [ ]
yarn testpasses - [ ] Tests are changed or added
- [x] Relevant documentation is changed or added (and PR referenced)
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Codecov Report
Merging #9908 (cc70363) into main (9831d3d) will increase coverage by
4.79%. The diff coverage is85.22%.
@@ Coverage Diff @@
## main #9908 +/- ##
==========================================
+ Coverage 78.34% 83.14% +4.79%
==========================================
Files 250 257 +7
Lines 18339 18554 +215
Branches 3955 3996 +41
==========================================
+ Hits 14368 15426 +1058
+ Misses 3840 3032 -808
+ Partials 131 96 -35
| Impacted Files | Coverage Δ | |
|---|---|---|
| packages/auth/src/Auth.ts | 86.80% <ø> (ø) |
|
| packages/core/src/constants.ts | 100.00% <ø> (ø) |
|
| packages/datastore/src/sync/index.ts | 73.16% <ø> (+59.74%) |
:arrow_up: |
| packages/datastore/src/sync/merger.ts | 91.30% <ø> (ø) |
|
| packages/datastore/src/sync/outbox.ts | 95.61% <ø> (+3.50%) |
:arrow_up: |
| ...ages/datastore/src/sync/processors/subscription.ts | 38.49% <22.22%> (+2.53%) |
:arrow_up: |
| packages/api-graphql/src/GraphQLAPI.ts | 87.50% <50.00%> (-0.42%) |
:arrow_down: |
| packages/api-rest/src/RestAPI.ts | 95.34% <50.00%> (-0.72%) |
:arrow_down: |
| ...-storage-adapter/src/common/CommonSQLiteAdapter.ts | 64.90% <64.90%> (ø) |
|
| packages/geo/src/Geo.ts | 81.63% <65.78%> (-13.89%) |
:arrow_down: |
| ... and 65 more |
:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more
You're welcome @elorzafe I still can't merge. Maybe you can mention another reviewer
This looks good. Thank you for making this change! I'm bringing the branch up to current now and will merge this in when the tests finish running.
Merged. Thanks again for the contribution!