Commit Graph

49 Commits (f90358666e0fed23c5b735228decb7dc3b01ce66)

Author SHA1 Message Date
JPR f90358666e Typos (doc) 2020-11-20 14:05:49 +01:00
珊瑚 961aaf5d1c
typo (#9886) 2020-09-06 12:12:38 +02:00
Florian Angeletti 442b7a55e0 manual: remove 'magical' prefixing 2019-12-06 09:52:22 +01:00
Florian Angeletti 345cfb6a98 manual: make labels mandatory 2019-12-05 17:31:04 +01:00
David Allsopp 7c2284eda3 Rename references to Pervasives to Stdlib 2019-06-26 18:11:58 +01:00
Jeffrey Tsang 40033ad7fb manual: doc clarification (#1984) 2018-08-16 22:45:52 +02:00
Xavier Leroy 570fe9f57b Remove old PDF-related macros that are no longer relevant
In the early days of pdflatex, the hyperref package didn't exist
and we used the \pdfchapter, \pdfchapterfold and \pdfsection
custom macros to build the PDF index.

Those macros are now useless, so remove all of their uses.
2018-06-16 10:36:00 +02:00
octachron 41c042c596 GPR#1194: caml_example make mode non-optional 2017-06-07 18:14:16 +02:00
Rob Blanco 1df87e0c1a Typo in lablexamples.etex 2017-04-03 16:15:20 +02:00
octachron 9d7ef6b61e Manual tools: guarded caml_example environment
This commit modifies the manual tool caml_tex2 to catch the status of
the output and raises an error in case of unexpected error of warning
message. Expected errors or warnings must be now marked explicitly.
There are two options to mark these expected errors or warnings:
The first option is to use the new optional parameter of the
`caml_example` environment, e.g.

\begin{caml_example}[warning=3]
  String.capitalize "a word";;
\end{caml_example}

or for an error:

\begin{caml_example}[error]
  1 +. 3.;;
\end{caml_example}

The second option is to use `[@@expect ..]` attribute before `;;` to
override locally the global expected status output:

\begin{caml_example}
  1 + 2 ;;
  1 +. 3. [@@expect error];;
  String.capitalize [@@expect warning 3];;
  3 + 4 ;;
\end{caml_example}

Note that the two options can be combined together, e.g

\begin{caml_example}[error]
  1 +. 3.;; (* an error is expected here *)
  1. +. 3. [@@expect ok] ;;
  1 + 3. ;; (* an error is still expected here *)
\end{caml_example}
2016-09-02 01:01:33 +02:00
octachron 4f131e3803 manual: alternative polymorphic variants intro 2015-12-18 21:42:55 +01:00
Damien Doligez b163689c26 update for byte sequences and immutable strings
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@14722 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-05-01 22:01:46 +00:00
Gabriel Scherer 10242bb96b Spellings (Patch by JP Rodi)
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@14567 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-04-09 15:20:36 +00:00
Damien Doligez 48d28e81f3 PR#5612: Rationalize spacing and parenteses use in the tutorial part of the manual
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@14053 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-09-02 11:38:40 +00:00
Luc Maranget 0b5a3a8e16 * Added an alias facility for (html) hyperlinks to syntax definitions
(cf. syntaxdef.hva)

* Tidied up a bit syntax hyperlinks

* Give fixed names to most (all ?) of files.



git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@13707 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-05-28 12:00:25 +00:00
Damien Doligez 3451de93e0 PR#5850: polymorphic variant typo
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@13302 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-02-19 10:54:15 +00:00
Jacques Garrigue 0bce6769dd typos and details
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@12761 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-07-24 03:18:52 +00:00
Damien Doligez d6bd0df1b3 various fixes
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@12733 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-07-19 11:06:49 +00:00
Damien Doligez 85e10f36c0 fixing quotes and other formatting problems
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@12178 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-02-21 12:56:14 +00:00
Damien Doligez 5e8e78b984 more renaming into OCaml
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@12146 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-02-10 14:30:49 +00:00
Damien Doligez 77d655c1b1 do not rewrite history, the old versions are still called Objective Caml
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@12094 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-01-27 13:58:41 +00:00
Jacques Garrigue 62fc9256eb change explanation about elimination of optional arguments, cf PR#5342
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@11310 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2011-12-14 09:21:33 +00:00
Damien Doligez d0c9826ddf renaming "Objective Caml" to "OCaml" (first pass)
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@11013 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2011-04-26 12:13:22 +00:00
Damien Doligez 1154875b5a PR#4881 typos
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@10193 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2009-10-02 09:14:34 +00:00
Jacques Garrigue e2094e092b wildcard and labels
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@10141 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2007-01-30 02:15:21 +00:00
Damien Doligez b499f6898b typo
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@10093 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2005-01-18 14:40:43 +00:00
Jacques Garrigue f47f50a04f coercions
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9980 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2002-06-19 03:25:28 +00:00
Jacques Garrigue 106a29ae87 typo
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9974 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2002-06-04 09:05:08 +00:00
Jacques Garrigue 0287f72cf7 PR#583
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9935 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2001-11-22 05:26:14 +00:00
Xavier Leroy 6f89407ccb MAJ pour 3.03 ALPHA
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9928 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2001-10-11 09:22:58 +00:00
Jacques Garrigue 09e0b4bb7d mise a` jour pour 3.03beta
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9925 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2001-10-01 09:00:47 +00:00
Xavier Leroy 8266ce07c0 Corrections pour 3.01
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9897 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2001-02-27 10:15:56 +00:00
Jacques Garrigue 0b4c461f35 variant changes
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9886 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-06-14 10:00:48 +00:00
Jacques Garrigue 73533c1abc ajout de cmp:
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9879 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-25 04:55:04 +00:00
Jacques Garrigue 4c6b229593 ajout de ms:
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9873 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-14 03:43:10 +00:00
Jacques Garrigue 87a2f47875 mise a jour de la syntaxe des labels
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9870 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-13 03:16:39 +00:00
Xavier Leroy dd0f0e9504 Typos
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9867 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-04 12:11:51 +00:00
Jacques Garrigue 94a6297f58 reorganisation des labels
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9866 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-04 10:02:22 +00:00
Jacques Garrigue 756cd74d34 commencons par adapter aux labels legers
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9864 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-04-04 02:38:59 +00:00
Damien Doligez 6e3e2bc820 "label mode" -> "commuting label mode"
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9857 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-03-24 19:32:25 +00:00
Damien Doligez e614bc1294 "modern" -> "label"
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9856 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-03-20 20:38:04 +00:00
Jacques Garrigue b063422b8e label change
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9855 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-02-29 08:00:32 +00:00
Jacques Garrigue a0623832a1 add #variant patterns
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9853 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-02-23 09:59:38 +00:00
Jacques Garrigue 83e9b117f1 commentaire sur la non-completude
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9852 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-02-17 14:11:24 +00:00
Jacques Garrigue 2c885eda40 warn about conflicts keyword/variable for :label abbreviation
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9850 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-02-07 02:02:23 +00:00
Jacques Garrigue 73470985c4 add item:
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9848 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-02-03 01:56:28 +00:00
Xavier Leroy 7020708b48 PDF fold incorrect
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9846 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2000-01-13 09:17:56 +00:00
Jacques Garrigue fa95c0a369 finished variants
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9836 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
1999-12-15 17:32:49 +00:00
Jacques Garrigue 409289bc29 error messages + labels
git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@9834 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
1999-12-14 17:47:24 +00:00