help_print_desc: Simplify implementation.

[dxcommon.git] / src / help.h

diff --git a/src/help.h b/src/help.h
index a78bc59c0b6fc48953d8e556a12d0b8ef34bc3c1..7dbb65de4efb7998bd0ea2b9b357aab3c8738b4c 100644 (file)
--- a/src/help.h
+++ b/src/help.h
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2021 Nick Bowler
+ * Copyright © 2021, 2023 Nick Bowler
  *
  * Helper functions for formatting --help program output.
  *
@@ -28,6 +28,9 @@ int help_print_optstring(const struct option *opt, const char *argname, int l);
  * with the context set to opt->name.  The first line will be indented by
  * i-w spaces (to account for the cursor being in some other column), all
  * other lines are indented by i spaces.
+ *
+ * The output always ends with a newline, regardless of whether or not the
+ * input string ends with a newline.
  */
 void help_print_desc(const struct option *opt, const char *desc, int i, int w);