Display of "double minus" in generated documentation files? about coccinelle HOT 5 OPEN

I have noticed that some curly brace pairs were added to the parameter description. I imagine that there is a better way to achieve a consistent display result.
How do you think about to mark command-line parameters in specific ways so that it would also become easier to distinguish between short and long options?

from coccinelle.

On Wed, 1 Oct 2014, Markus Elfring wrote:

I have noticed that some curly brace pairs were added to the parameter
description. I imagine that there is a better way to achieve a consistent
display result.
How do you think about to mark command-line parameters in specific ways so
that it would also become easier to distinguish between short and long
options?

Why are you complaining about the latex source of the manual? As far as I
know, it is only used to generate a pdf file. As far as I can see, the
pdf now looks fine, as you asked for, with a clear delimter between the
two hyphens. What more is wanted?

http://coccinelle.lip6.fr/docs/options.pdf

julia

from coccinelle.

As far as I can see, the pdf now looks fine, as you asked for, with a clear delimter between the two hyphens.

Thanks for your documentation improvement.

What more is wanted?

I suggest to consider a few more implementation details for clarification now.

• Parameters are mentioned in the section "Introduction" with a single leading hyphen while they are listed with double hyphens at other places. Are both notations officially supported?
• How do you think about to improve the document structure with strict logical markup? Would it be useful to move corresponding text fomatting to a dedicated TeX package?

from coccinelle.

On Thu, 2 Oct 2014, Markus Elfring wrote:

  As far as I can see, the pdf now looks fine, as you asked for,
  with a clear delimter between the two hyphens.

Thanks for your documentation improvement.

  What more is wanted?

I suggest to consider a few more implementation details for clarification
now.

• Parameters are mentioned in the section "Introduction" with a single
  leading hyphen while they are listed with double hyphens at other
  places. Are both notations officially supported?
• How do you think about to improve the document structure with strict
  logical markup? Would it be useful to move corresponding text fomatting
  to a dedicated TeX package?

I will check on the single hyphens. Both notations are supported (you
could have answered that question yourself), but the user is not supposed
to be aware of that.

I don't want to further invest in the perfection of the presentation of
the documentation.

julia

from coccinelle.

Both notations are supported

Thanks for your acknowledgement.

(you could have answered that question yourself),

I try to avoid assumptions so that the potential for misunderstandings can be a bit reduced.

but the user is not supposed to be aware of that.

It is nice when variations in leading hyphens can be safely handled.

from coccinelle.