NotificationsYou must be signed in to change notification settings
Fork1.1k
Star5.7k

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

MPR#7551: manual, make final ";;" potentially optional in caml_example#1194

Merged

gasche merged 3 commits intoocaml:trunkfromOctachron:tune_caml_example

Jun 7, 2017

Merged

MPR#7551: manual, make final ";;" potentially optional in caml_example#1194

gasche merged 3 commits intoocaml:trunkfromOctachron:tune_caml_example

Jun 7, 2017

Conversation

Copy link

Member

Octachron commentedJun 7, 2017

MPR#7551:
This PR makes it possible to omit the final;; in a caml_example environment.
By default, this final;; is still mandatory and a new command line option-implicit-stop makes it optional globally.

This global setting can be overrided locally by adding an optional argument to the environment:

[toplevel] makes the final;; mandatory
[verbatim] makes it optional

This new optional argument must precedes the expected status argument:

\begin{caml_example*}[verbatim][error]1 + 2.\end{caml_example}

The tutorial part of the manual is configured to use the globally mandatory;; mode for the sake of consistency whereas the language extension section uses the new optional;; mode.

MPR#7551: allow caml_example to omit final ";;"

80b394c

This commit makes it possible to omit the final ";;" in a caml_exampleenvironment.By default, this final ";;" is still mandatory. A new command lineoption "-implicit-stop" makes it optional globally.This global setting can be overrided locally by adding an optionalargument to the environment:* [toplevel] makes the ";;" mandatory* [verbatim] makes it optionalThe tutorial part of the manual is configured to use the mandatory ";;"mode globally for the sake of consistency whereas the language extensionsection uses the new optional ";;" mode.

Copy link

Member

gasche commentedJun 7, 2017•
edited
Loading

I appreciate you going the extra mile for convenience, but I don't like the idea that the same usage of the environment will have different default behaviors in different parts of the manual. We save 10 characters each time, but at the cost of auto-discoverability of behavior -- think of beginners that just jump in the.etex file and play around from what is already there. Could you disable that part and we would just use[verbatim] and[toplevel] each time? (You could fail if no such argument is provided.)

mshinwell changed the title~~MPR#7551: manual, make final ";;" potentiallt optional in caml_example~~MPR#7551: manual, make final ";;" potentially optional in caml_example

Jun 7, 2017

Copy link

MemberAuthor

Octachron commentedJun 7, 2017

Disabling the difference of behaviors is quite straightforward. I am not sure how it implies a need for explicitness of the mode: we could also default to the current behavior. Nevertheless, being explicit would probably be better in a future where the two modes are rendered differently. So it might be better to make[optional|vebatim] non optional (and transform them to {optional|verbatim} to follow latex conventions).