Edits to source code comments

darcs-hash:20060608235557-ac50b-052e5c8f2cceb554064d7408573f277275903e7b.gz

1 files changed, 5 insertions, 0 deletions

diff --git a/builtin.h b/builtin.h
index fbfd22fd..95d83767 100644
--- a/builtin.h
+++ b/builtin.h
@@ -141,6 +141,11 @@ int builtin_count_args( wchar_t **argv );
 /**
    Print help for the specified builtin. If \c b is sb_err, also print
    the line information
+
+   If \c b is the buffer representing standard error, and the help
+   message is about to be printed to an interactive screen, it may be
+   shortened to fit the screen.
+
 */
 void builtin_print_help( wchar_t *cmd, string_buffer_t *b );