Review fixes v3

Author: MaciejKaras

scripts/release/calculate_next_version.py

@@ -10,7 +10,10 @@
 from scripts.release.release_notes import calculate_next_version_with_changelog
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        description="Calculate the next version based on the changes since the previous version tag.",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
     parser.add_argument(
         "-p",
         "--path",
@@ -46,7 +49,6 @@
         type=str,
         help=f"Version to use if no previous version tag is found. Default is '{DEFAULT_INITIAL_GIT_TAG_VERSION}'",
     )
-    parser.add_argument("--output", "-o", type=pathlib.Path)
     args = parser.parse_args()
 
     repo = Repo(args.path)

scripts/release/create_changelog.py

@@ -15,7 +15,10 @@
 )
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
+    parser = argparse.ArgumentParser(
+        description="Utility to easily create a new changelog entry file.",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
     parser.add_argument(
         "-c",
         "--changelog-path",

scripts/release/release_notes.py

@@ -72,7 +72,10 @@ def calculate_next_version_with_changelog(
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        description="Generate release notes based on the changes since the previous version tag.",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
     parser.add_argument(
         "-p",
         "--path",
@@ -108,7 +111,13 @@ def calculate_next_version_with_changelog(
         type=str,
         help=f"Version to use if no previous version tag is found. Default is '{DEFAULT_INITIAL_GIT_TAG_VERSION}'",
     )
-    parser.add_argument("--output", "-o", type=pathlib.Path)
+    parser.add_argument(
+        "--output",
+        "-o",
+        metavar="",
+        type=pathlib.Path,
+        help="Path to save the release notes. If not provided, prints to stdout.",
+    )
     args = parser.parse_args()
 
     release_notes = generate_release_notes(