Skip to content

Check function docstring has changed #4085

@germa89

Description

@germa89

With the implementation of #4060 (thanks @clatapie for this), we need to make sure that the overwritten commands docstring matches the docs docstring as much as possible.

For instance we do redefine /FILE in mapdl_extended.py. There we overwrite most of the command docstring. So anytime we update the original docstring, we should make sure we update the docstring in mapdl_extended.py.

This should be very few cases, since most of the stuff done on the commands is to easy its usage, not changing function signature and such. Hence if using functools.wraps correctly (I need to check if we are), there should be little commands to update.

Opening this issue so I can keep track of this.

@clatapie if you have something in mind, I am happy to heard it. Otherwise, I will think how to address this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions