Skip to content

Commit

Permalink
prettified strings_to_categoricals docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
falexwolf committed Dec 10, 2018
1 parent 66cc620 commit 0b0ec7c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
12 changes: 9 additions & 3 deletions anndata/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1375,12 +1375,18 @@ def rename_categories(self, key, categories):
def strings_to_categoricals(self, df=None):
"""Transform string annotations to categoricals.
Only considers string annotations that lead to less categories than the
Only affects string annotations that lead to less categories than the
total number of observations.
If `df` is not `None`, modifies the passed df inplace.
Params
------
df : `pd.DataFrame`, `None`
If `df` is `None`, modifies both `.obs` and `.var`, otherwise
modifies `df` inplace.
Makes a view a copy.
Notes
-----
Turns the view of an `AnnData` into an actual `AnnData`..
"""
dont_modify = False # only necessary for backed views
if df is None:
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
#autodoc_default_flags = ['members']
napoleon_use_rtype = False
napoleon_use_param = True
napoleon_custom_sections = [('Params', 'Parameters')]

intersphinx_mapping = dict(
python=('https://docs.python.org/3', None),
Expand Down

0 comments on commit 0b0ec7c

Please sign in to comment.