Skip to content

Docs: Add type hints and examples to cross_metadata docstring #1216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abdullahiftikharcode wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: Add type hints and examples to cross_metadata docstring #1216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion malariagen_data/ag3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ def _repr_html_(self):
"""
return html

def cross_metadata(self):
def cross_metadata(self) -> pd.DataFrame:
"""Load a dataframe containing metadata about samples in colony crosses,
including which samples are parents or progeny in which crosses.

Expand All @@ -347,6 +347,14 @@ def cross_metadata(self):
df : pandas.DataFrame
A dataframe of sample metadata for colony crosses.

Examples
--------
Access cross metadata:

>>> import malariagen_data
>>> ag3 = malariagen_data.Ag3()
>>> df = ag3.cross_metadata()

"""
debug = self._log.debug

Expand Down