Skip to content

I think the get_user_info docs don't match the code #245

Closed
@sbillinge

Description

@sbillinge

Problem

The docs don't seem to correspond to the code.

I was tweaking the docs and checking the code. Places where I didn't update the docs it is because I think the docs are better behavior than the code....

Proposed solution

update the code to match the docs (with tests).

One thing I remember concretely is that get_user_info gets an optional argument of args that is type argparse.Namespace but the docs say a dict can be passed.

Since we decided to make this a user-facing functionality that can be used by others, I think it is more reusable if it takes a dict and not the full args Namespace?

But there may be other things, so have someone go through the docs and type all the commands illustrated in there and make sure the code actually does what it says.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions