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.

Sign up for GitHub

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

Jump to bottom

CreateUserServicePassword type documentation incorrect #1223

Open
KeithGillette opened this issue Jun 7, 2022 · 1 comment
Open

CreateUserServicePassword type documentation incorrect #1223

KeithGillette opened this issue Jun 7, 2022 · 1 comment
Labels
bug

Comments

@KeithGillette
Copy link

Bug report

Describe the bug

The MongoServicePassword.createUser API documentation:

  1. Lists CreateUserServicePassword as the type for each of that method's parameter properties but the API documentation does not define CreateUserServicePassword, which I believe is the type of the parameter itself.
  2. Includes no Description for the parameter properties, leaving me clueless as to what a cleanUser is.

To Reproduce

Read the referenced documentation.

Expected behavior

The documentation should be accurate, complete, and understandable.

Screenshots

N/A

System information

  • Version of accounts-js: latest

Additional context

N/A
@mrcleanandfresh
Copy link
Contributor

mrcleanandfresh commented Sep 16, 2022 •
edited
Loading

@pradel this is as simple as making password optional in CreateUserServicePassword, right?

I can submit a PR to fix this when I have some time this weekend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mrcleanandfresh @KeithGillette