Skip to content

Commit ad28d6a

Browse files
authored
Fix API rendering? (#558)
1 parent 760b6b0 commit ad28d6a

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

cf_xarray/groupers.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77

88
@dataclass
99
class FlagGrouper(UniqueGrouper):
10+
"""
11+
Grouper object that allows convenient categorical grouping by a CF flag variable.
12+
13+
Labels in the grouped output will be restricted to those listed in ``flag_meanings``.
14+
"""
15+
1016
def factorize(self, group) -> EncodedGroups:
1117
if "flag_values" not in group.attrs or "flag_meanings" not in group.attrs:
1218
raise ValueError(

doc/api.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Geometries
2121
----------
2222
.. autosummary::
2323
:toctree: generated/
24-
geometry.decode_geometries
2524

25+
geometry.decode_geometries
2626
geometry.encode_geometries
2727
geometry.shapely_to_cf
2828
geometry.cf_to_shapely
@@ -33,7 +33,8 @@ Groupers
3333
--------
3434
.. autosummary::
3535
:toctree: generated/
36-
groupers.FlagGrouper
36+
37+
groupers.FlagGrouper
3738

3839
.. currentmodule:: xarray
3940

0 commit comments

Comments
 (0)