Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

📝 Add missing limit docstring #451

Merged
merged 1 commit into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,4 @@ docs/lnschema_core.*
lamin_sphinx
docs/conf.py
_docs_tmp*
test.ipynb
6 changes: 4 additions & 2 deletions lnschema_core/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -652,17 +652,19 @@ def df(
join: str = "inner",
limit: int = 100,
) -> pd.DataFrame:
"""Convert to `pd.DataFrame`.
"""Convert to :class:`pd.DataFrame`.
Zethson marked this conversation as resolved.
Show resolved Hide resolved

By default, shows all direct fields, except `updated_at`.

If you'd like to include other fields, use parameter `include`.
Use parameter `include` to include other fields
Zethson marked this conversation as resolved.
Show resolved Hide resolved

Args:
include: Related fields to include as columns. Takes strings of
form `"labels__name"`, `"cell_types__name"`, etc. or a list
of such strings.
join: The `join` parameter of `pandas`.
limit: Maximum number of rows to display from a Pandas DataFrame.
Defaults to 100 to reduce database load.

Examples:
>>> labels = [ln.ULabel(name="Label {i}") for i in range(3)]
Expand Down
Loading