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.

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

fix two docstrings that make API docs unhappy #1441

Merged
merged 1 commit into from
Jun 4, 2023
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
2 changes: 1 addition & 1 deletion metaflow/plugins/cards/card_modules/card.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def _get_mustache(self):
except ImportError:
return None

def render(self, task: "Task") -> str:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@romain-intel this "Task" broke the API docs - given that it is a string, it is probably not useful/necessary as a type annotation

def render(self, task) -> str:
"""
Produce custom card contents in HTML.

Expand Down
2 changes: 1 addition & 1 deletion metaflow/plugins/kubernetes/kubernetes_decorator.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class KubernetesDecorator(StepDecorator):
Path to tmpfs mount for this step. Defaults to /metaflow_temp.
persistent_volume_claims: Dict[str, str], optional
A map (dictionary) of persistent volumes to be mounted to the pod for this step. The map is from persistent
volumes to the path to which the volume is to be mounted, e.g., { "pvc-name": "/path/to/mount/on" }.
volumes to the path to which the volume is to be mounted, e.g., `{'pvc-name': '/path/to/mount/on'}`.
"""

name = "kubernetes"
Expand Down