Skip to content

docs: add docstrings for argument and option helpers #540

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
aoright wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add docstrings for argument and option helpers #540

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
4 changes: 3 additions & 1 deletion src/cleo/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ def argument(
multiple: bool = False,
default: Any | None = None,
) -> Argument:
"""Create a new command line argument."""
return Argument(
name,
required=not optional,
Expand All @@ -31,6 +32,7 @@ def option(
multiple: bool = False,
default: Any | None = None,
) -> Option:
"""Create a new command line option."""
return Option(
long_name,
short_name,
Expand All @@ -44,7 +46,7 @@ def option(

def tokenize(string: str) -> list[str]: # pragma: no cover
"""
Split the string using shell-like syntax. Maps directly to using `shlex.split`
Split the string using shell-like syntax. Maps directly to using `shlex.split`.
"""
import shlex

Expand Down
Loading