Backport PR scverse#1402: Update to_df docstrings

meeseeksmachine · Mar 11, 2024 · 51e3226 · 51e3226
1 parent 767c2be
commit 51e3226
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/anndata/_core/anndata.py b/anndata/_core/anndata.py
@@ -1282,7 +1282,7 @@ def transpose(self) -> AnnData:
 
     T = property(transpose)
 
-    def to_df(self, layer=None) -> pd.DataFrame:
+    def to_df(self, layer: str | None = None) -> pd.DataFrame:
         """\
         Generate shallow :class:`~pandas.DataFrame`.
 
@@ -1295,8 +1295,12 @@ def to_df(self, layer=None) -> pd.DataFrame:
 
         Params
         ------
-        layer : str
+        layer
             Key for `.layers`.
+
+        Returns
+        -------
+        Pandas DataFrame of specified data matrix.
         """
         if layer is not None:
             X = self.layers[layer]

diff --git a/docs/release-notes/0.10.6.md b/docs/release-notes/0.10.6.md
@@ -13,6 +13,8 @@
 ```{rubric} Documentation
 ```
 
+* Type hints and docstrings for `.to_df` method are updated and fixed {pr}`1402` {user}`WeilerP`
+
 ```{rubric} Performance
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,8 @@ @@
     ```{rubric} Documentation
     ```
+    * Type hints and docstrings for `.to_df` method are updated and fixed {pr}`1402` {user}`WeilerP`
     ```{rubric} Performance
     ```
@@ Expand Down @@