Description Text Alignment and Spacing

[noctuid]

First off, thank you for the nice library.

I have noticed that if the combination of the short opt, long opt, and meta-var is longer than the default padding before the description text, it will run into the description text and push it over without leaving a space in the help message:

-h, --help               Print this help text.
-o, --long-opt-is-long META VAR IS LONGThis is the description text.

It would be nice if the padding before the description text would automatically adjust or at least if a space would be put before the description text in this case. Also, is there some way to have the description text take up multiple lines but have each new line start at the same position (instead of all the way to the left)? For example:

-h, --help               Print this help text.
                         Print this next line aligned.

I think that would be nice as well.

On an unrelated note, emacs is indenting the args to define-opts weirdly for me. The first two "(:name ...)"s are being indented 4 spaces and the rest of them are being indented 2 spaces. Would you happen to have any idea why this is happening?

(define-opts
    (:name :help
     ...)
    (:name ...)
  (:name ...)
  (:name ...))

[mrkkrp]

About too long combinations of options and metavars: yes, this is absolutely possible and I will probably implement it soon.

---

About description text: do you mean it should happen when description contains newlines?

---

Yeah, I know about that problem with indentation. In Emacs Lisp, there is (declare (indent …)) thing, I'm not sure there is something similar in Common Lisp. This is because Emacs Lisp is tightly integrated with the editor, while Common Lisp cannot know anything about indentation. If you're using Emacs, you probably using SLIME. Please ask how custom macro can declare (if possible) how they should be indented. You can use this example to demonstrate the issue.

[mrkkrp]

@noctuid, Aha, I figured out that if we use &body instead of &rest in define-opts indentation is fixed. No worries, I'll commit necessary changes soon.

[mrkkrp]

@noctuid, I've decided that if combination of options and meta-var is longer than 25 characters (there are 2 character padding on the left, it doesn't count), then description will be put on the second file. This shouldn't look too ugly.

[noctuid]

Great. Thank you for the changes. I'll try them when I get a chance.

[noctuid]

@mrkkrp Alright, it looks good. Starting the description on the second line is what other option parsing libraries I've used in other languages do (and makes more sense than cramming all the text to the right). Thank you.