Skip to content

Commit

Permalink
Improve doc strings.
Browse files Browse the repository at this point in the history
  • Loading branch information
hXtreme committed May 3, 2022
1 parent 536ee0b commit f1da627
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion tasks3/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def task(ctx: click.core.Context):
@click.option(
"--id",
type=str,
help="Filter by id. "
help="Filter by id."
"You can pass /partial-id/ to search for all tasks whose id contains partial-id.",
)
@click.option("-T", "--title", type=str, help="Search by Title")
Expand Down
15 changes: 7 additions & 8 deletions tasks3/db/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,13 @@ class Task(Base):
SQLAlchemy declarative model for the tasks3 database containing tasks.
Attributes:
id: Unique ID for the task.
title: Title of the task.
urgency: Urgency level[0-4] of the task.
importance: Importance level[0-4] of the task.
tags: Set of tags to apply to the task.
folder: Anchor this task to a particular directory or file.
description: Description of the task.
:param id: Unique ID for the task.
:param title: Title of the task.
:param urgency: Urgency level[0-4] of the task.
:param importance: Importance level[0-4] of the task.
:param tags: Set of tags to apply to the task.
:param folder: Anchor this task to a particular directory or file.
:param description: Description of the task.
"""

title = Column(Unicode, nullable=False)
Expand Down

0 comments on commit f1da627

Please sign in to comment.