Skip to content

Doc improvements #1463

@corasaurus-hex

Description

@corasaurus-hex

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

I'm trying to use documentation to understand the arguments to functions in functions.py.

Describe the solution you'd like

I'd love if all the function docstrings had documentation for the arguments to the function. For example, alias has descriptions of its arguments.

Describe alternatives you've considered

None, really, just recording it as a unit of work that would improve the project.

Additional context

This is a follow-on issue to @ntjohnson1 excellent work in #1435 where he added tons of helpful examples. I was browsing the code in the PR and realized quite a few functions were missing argument documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions