Skip to content

"bottom-up" search in interpolation functions #2552

@alexcharn5

Description

@alexcharn5

What can be better?

Hello,

In at least two functions (interpolate_to_isosurface and isentropic_interpolation), the description of the "bottom_up_search" parameter is somewhat confusing as written. Particularly for the former, whose documentation says "This function assumes that highest vertical level (lowest pressure) is zeroth index." Then, bottom_up_search set to True (the default) searches from the "bottom up" in the sense of low indices to high indices, but from the top down in the physical sense of the atmosphere. To me, it's fine if the code stays as it is, but this physical interpretation should be added to the documentation to avoid confusing people.

Thanks,
Alex Charn

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area: DocsAffects documentationType: EnhancementEnhancement to existing functionality

    Type

    No type

    Projects

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions