command-line-interface-pages / syntax

Syntax definition and highlighting for different editors
4 stars 0 forks source link

Solve issue with {option ...} placeholder #35

Closed EmilyGraceSeville7cf closed 1 year ago

EmilyGraceSeville7cf commented 1 year ago

Option now accepts just two arguments and intended to show long or short options. But it breaks standardization and makes impossible to write something like this:

- Display differences in [d]ecimal/[a]SCII format:

`comp {option format: /d, /a} {/?file file 1} {/?file file 2}`

This workaround:

- Display differences in [d]ecimal/[a]SCII format:

`comp {option decimal format: /d|option ASCII format: /a} {/?file file 1} {/?file file 2}`

results in unsupported placeholder.

How to solve?

On the other hand I can introduce comprehensive placeholders first and then make option placeholder comprehensive. It makes sense to always list all available options in the context of some code example.