Skip to content
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

📝 Use CanCurate instead of CanValidate in docs #93

Merged
merged 1 commit into from
Nov 18, 2024
Merged

📝 Use CanCurate instead of CanValidate in docs #93

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
6 changes: 3 additions & 3 deletions lamin_utils/_inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
class InspectResult:
"""Result of inspect.

An InspectResult object of calls such as :meth:`~lamindb.core.CanValidate.inspect`.
An InspectResult object of calls such as :meth:`~lamindb.core.CanCurate.inspect`.
"""

def __init__(
Expand All @@ -41,12 +41,12 @@ def df(self) -> pd.DataFrame:

@property
def validated(self) -> list[str]:
"""List of successfully :meth:`~lamindb.core.CanValidate.validate` validated items."""
"""List of successfully :meth:`~lamindb.core.CanCurate.validate` validated items."""
return self._validated

@property
def non_validated(self) -> list[str]:
"""List of unsuccessfully :meth:`~lamindb.core.CanValidate.validate` items.
"""List of unsuccessfully :meth:`~lamindb.core.CanCurate.validate` items.

This list can be used to remove any non-validated values such as
genes that do not map against the specified source.
Expand Down
Loading