Skip to content

Fix API rendering? #558

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

Merged
merged 2 commits into from
Mar 6, 2025
Merged

Fix API rendering? #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19ea33e
Fix API rendering?
dcherian Mar 6, 2025
3462711
add docstring
dcherian Mar 6, 2025
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
6 changes: 6 additions & 0 deletions cf_xarray/groupers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

@dataclass
class FlagGrouper(UniqueGrouper):
"""
Grouper object that allows convenient categorical grouping by a CF flag variable.

Labels in the grouped output will be restricted to those listed in ``flag_meanings``.
"""

def factorize(self, group) -> EncodedGroups:
if "flag_values" not in group.attrs or "flag_meanings" not in group.attrs:
raise ValueError(
Expand Down
5 changes: 3 additions & 2 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Geometries
----------
.. autosummary::
:toctree: generated/
geometry.decode_geometries

geometry.decode_geometries
geometry.encode_geometries
geometry.shapely_to_cf
geometry.cf_to_shapely
Expand All @@ -33,7 +33,8 @@ Groupers
--------
.. autosummary::
:toctree: generated/
groupers.FlagGrouper

groupers.FlagGrouper

.. currentmodule:: xarray

Expand Down
Loading