Manual: caml_example for language extensions#939
Conversation
|
This is very nice, and it's enough work that I think there should be a Change entry. One thing you could do is to merge it with the entry for #693. |
|
(To clarify my thinking a bit, I think some software projects have or give the unfortunate impression that changes to the documentation are of lesser value than changes to the program code. We don't want to do that; in particular, we should not let the people that take some much-needed care of the manual self-censor themselves by downsizing the effort involved.) |
manual/manual/refman/exten.etex
Outdated
| \endcaml | ||
| polymorphic: | ||
| \begin{caml_example}[error] | ||
| let id: 'a. 'a -> 'a = fun x -> x |
There was a problem hiding this comment.
Nice catch! Thanks.
As a side-note, the crucial error here was the missing ;; at the end of the caml_example
that circumvented the status detection for the caml_example. This is fixed in the new version
of the PR.
7f3c7b7 to
a57a5d4
Compare
|
I have added an item to the Changelog in the manual section: I thought it will be better for readability to not group together changes with quite different objects; even if they share a common internal purpose. I have also added a missing double semi-colon detection logic for |
|
@lavib if you wanted to be credited as a reviewer in the Changelog, which name would you prefer us to use? (Usually we use real-name-looking names, but some people have other preferences.) Did you review the whole PR, or just randomly peeked and saw this one issue? |
|
No needs to credit me, thanks. It was just a quick & incomplete review.
2016-11-29 19:42 GMT+01:00 Gabriel Scherer <notifications@github.com>:
… @lavib <https://github.com/lavib> if you wanted to be credited as a
reviewer in the Changelog, which name would you prefer us to use? (Usually
we use real-name-looking names, but some people have other preferences.)
Did you review the whole PR, or just randomly peeked and saw this one issue?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#939 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ADdluVhj37ehtg9ds9ONL5Zhza_edzwTks5rDHITgaJpZM4K-M9i>
.
|
|
Ok, I went ahead and merged then. Thanks for the nice work! |
Manual: caml_example for language extensions
IRC: avoid unnecessary round.
* Adds package autocomplete search to the search dropdown * factor highlight_search_terms into a component * add interactive search to packages page
This PR proposes to use the caml_example pseudo-environment in the language extension section of the manual. This section already contains handwritten code example that mimics the output style of the
caml_example pseudo-environment. Moreover, the protection against unexpected errors and warnings in #693 should make safer the use of these environment in this part of the documentation.
The first commit in this PR simply add the possibility to use these environment in
exten.etex. The second and third commit convert some examples that were already using handwritten\caml … \endcamlenvironment and relatedverbatimenvironment.The last commit is (probably) partially unrelated but fixes a missing
font-family:monospacestyle declaration in the generated html − and removes an unneeded hack.