Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to format Arg.info doc? #180

Open
glacambre opened this issue Jul 19, 2023 · 1 comment
Open

How to format Arg.info doc? #180

glacambre opened this issue Jul 19, 2023 · 1 comment

Comments

@glacambre
Copy link

Dear maintainer,

Thank you for maintaining Cmdliner. It is a wonderful library and possibly one of the most ergonomic ones I've ever used :).

I am encountering an issue which I couldn't figure out a solution to. I have an option (Cmdliner.Arg) whose documentation (info.doc) is a little big and not very readable. I would like to insert linebreaks or split it into multiple sections.

I tried many things: inserting \ns, escaping them, putting them in markup, raw groff, escaped raw groff... nothing worked. Reading the Documentation Markup Language section of cmdliner's documentation, I'm under the impression that what I am trying to achieve is simply not currently possible.

Am I mistaken? If yes, what would be the right way to provide more formatting for an Arg.info's doc?

@dbuenzli
Copy link
Owner

dbuenzli commented Sep 6, 2023

Sorry @glacambre it seems I missed your request. No I don't think you are mistaken.

Currently this is being used to render options docs. I'm not sure whether this is amenable to multiparagraphs but it's not an unreasonable request. (I see git's manpages do seem to have multi paragraph option descriptions so something must be amenable to it but I'm no groff expert).

Starting a new paragraph after "\n\n" would feel reasonably backwards compatible to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants