doc: Update pyproject and cli descriptions

Reflects forge project description.
This commit is contained in:
Marty Oehme 2025-04-01 11:46:26 +02:00
parent 887c4cc4db
commit 790b5b4bad
Signed by: Marty
GPG key ID: 4E535BC19C61886E
2 changed files with 11 additions and 2 deletions

View file

@ -1,7 +1,7 @@
[project]
name = "topen"
version = "0.1.0"
description = "Add your description here"
description = "Quickly edit notes for your taskwarrior tasks"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [

View file

@ -28,7 +28,16 @@ TOPEN_QUIET = os.getenv("TOPEN_QUIET", False)
def parse_cli() -> argparse.Namespace:
parser = argparse.ArgumentParser(description="Taskwarrior note editing made easy.")
parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
description="Taskwarrior note editing made easy.",
epilog="""Provide a taskwarrior task id or uuid and topen creates a
new note file for or lets you edit an existing one.
Additionally it adds a small annotation to the task
to let you see that there exists a note file next time
you view the task.
""",
)
_ = parser.add_argument(
"id", help="The id/uuid of the taskwarrior task for which we edit notes"
)