Skip to content

Docstrings for functions in point.py, grid.py are missing some details and are not PyLance compatible #113

@Tyler-g-hudson

Description

@Tyler-g-hudson

The following functions have non-PyLance compatible docstrings:

calc_solid_earth_tides_grid, calc_solid_earth_tides_point_per_day, calc_solid_earth_tides_point

This can make it difficult to use these functions in an IDE, as the non-standard docstrings will fail to format using the regular visualization tools.

In addition to this, the functions under point.py do not specify if lat/lon inputs are to be in degrees or radians, and default values for parameters that have them are not specified in the docstring. The return values in point.py could likewise use some clarification for new users.

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