Skip to content

Commit

Permalink
Expand documentation of cell_sans.
Browse files Browse the repository at this point in the history
  • Loading branch information
salt-die committed Aug 22, 2024
1 parent 4a32a51 commit b2d473b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion src/batgrl/text_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,19 @@ def is_word_char(char: str) -> bool:

@lru_cache
def cell_sans(*names: str) -> list[str]:
"""Fields of a Cell array not in names."""
r"""
Return all fields of ``Cell`` not in names.
Parameters
----------
\*names : str
Excluded fields of ``Cell``.
Returns
-------
list[str]
All fields of ``Cell`` not in names.
"""
return [name for name in Cell.names if name not in names]


Expand Down

0 comments on commit b2d473b

Please sign in to comment.