Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docstrings with incorrect anchor order #90

Merged
merged 5 commits into from
Mar 24, 2023
Merged

Fix docstrings with incorrect anchor order #90

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ee1ae89
Updated docstrings and error message to correctly represent anchor order
ESadek-MO Jan 16, 2023
f131185
Updated docstrings to maintain consistency: 'temperature-pressure pai…
ESadek-MO Jan 16, 2023
f21e6c4
Updated docstrings in to maintain consistency: updated further refere…
ESadek-MO Jan 16, 2023
ec7258b
Made docstrings easier to read
ESadek-MO Mar 20, 2023
f753012
Update tephi/isopleths.py
bjlittle Mar 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions tephi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,9 +595,9 @@ def __init__(
A :class:`tephi.Locator` instance or a numeric step size
for the dry adiabat lines.
* anchor:
A sequence of two pressure, temperature pairs specifying the extent
of the tephigram plot in terms of the bottom left hand corner and
the top right hand corner. Pressure data points must be in units of
A sequence of two (pressure, temperature) pairs specifying the extent
of the tephigram plot in terms of the bottom right-hand corner, and
the top left-hand corner. Pressure data points must be in units of
mb or hPa, and temperature data points must be in units of degC.

For example:
Expand Down Expand Up @@ -801,9 +801,9 @@ def __init__(
or len(self._anchor) != 2
):
msg = (
"Invalid anchor, expecting [(bottom-left-pressure, "
"bottom-left-temperature), (top-right-pressure, "
"top-right-temperature)]"
"Invalid anchor, expecting [(bottom-right-pressure, "
"bottom-right-temperature), (top-left-pressure, "
"top-left-temperature)]"
)
raise ValueError(msg)
(
Expand Down Expand Up @@ -839,7 +839,7 @@ def plot(self, data, **kwargs):

Args:

* data: pressure and temperature pair data points.
* data: (pressure, temperature) pair data points.

.. note::
All keyword arguments are passed through to
Expand Down
4 changes: 2 additions & 2 deletions tephi/isopleths.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ def _wet_adiabat_gradient(min_temperature, pressure, temperature, dp):
calculate the gradient difference.

Returns:
The gradient change as a pressure, potential temperature value pair.
The gradient change as a (pressure, potential-temperature) value pair.

"""

Expand Down Expand Up @@ -416,7 +416,7 @@ def __init__(self, data, axes):
if self.data.ndim != 2 or self.data.shape[-1] != 2:
msg = (
"The environment profile data requires to be a sequence "
"of pressure, temperature value pairs."
"of pressure-temperature value pairs."
bjlittle marked this conversation as resolved.
Show resolved Hide resolved
)
raise ValueError(msg)
self.axes = axes
Expand Down