From 4f9a5483f1c29d48180fc4c8eda9f561726c3cce Mon Sep 17 00:00:00 2001 From: lubegasimon Date: Thu, 10 Feb 2022 20:49:26 +0300 Subject: [PATCH] promote tests --- test/generators/markdown/Alias.X.md | 3 +- test/generators/markdown/Bugs.md | 4 +- test/generators/markdown/Bugs_post_406.md | 3 +- test/generators/markdown/Include.md | 12 +- .../markdown/Include2.Y_include_synopsis.md | 3 +- test/generators/markdown/Include2.md | 3 +- test/generators/markdown/Include_sections.md | 6 +- test/generators/markdown/Labels.md | 2 +- test/generators/markdown/Markup.md | 53 ++++++-- test/generators/markdown/Module.md | 4 +- test/generators/markdown/Nested.F.md | 3 +- test/generators/markdown/Ocamlary.Aliases.md | 6 +- .../Ocamlary.CanonicalTest.Base_Tests.md | 6 +- .../Ocamlary.CollectionModule.InnerModuleA.md | 6 +- ...peOf.argument-1-Collection.InnerModuleA.md | 6 +- ...ary.FunctorTypeOf.argument-1-Collection.md | 3 +- .../markdown/Ocamlary.IncludeInclude1.md | 6 +- .../markdown/Ocamlary.ModuleWithSignature.md | 3 +- .../Ocamlary.Recollection.InnerModuleA.md | 6 +- ....Recollection.argument-1-C.InnerModuleA.md | 6 +- .../Ocamlary.Recollection.argument-1-C.md | 3 +- test/generators/markdown/Ocamlary.md | 124 +++++++++++------- .../Ocamlary.module-type-A.Q.InnerModuleA.md | 6 +- .../Ocamlary.module-type-B.Q.InnerModuleA.md | 6 +- .../Ocamlary.module-type-C.Q.InnerModuleA.md | 6 +- ...ary.module-type-COLLECTION.InnerModuleA.md | 6 +- ...Ocamlary.module-type-MMM.C.InnerModuleA.md | 6 +- .../Ocamlary.module-type-NestedInclude1.md | 3 +- ...le-type-RecollectionModule.InnerModuleA.md | 6 +- ...Ocamlary.module-type-RecollectionModule.md | 3 +- .../Ocamlary.module-type-SigForMod.Inner.md | 3 +- .../markdown/Ocamlary.module-type-SuperSig.md | 12 +- ...odule-type-SuperSig.module-type-SubSigA.md | 3 +- .../Ocamlary.module-type-ToInclude.md | 3 +- test/generators/markdown/Recent.md | 14 +- .../markdown/Recent.module-type-PolyS.md | 2 +- test/generators/markdown/Section.md | 4 +- test/generators/markdown/Stop.md | 10 +- .../generators/markdown/Stop_dead_link_doc.md | 2 +- .../Toplevel_comments.Comments_on_open.md | 3 +- .../Toplevel_comments.Ref_in_synopsis.md | 3 +- test/generators/markdown/Toplevel_comments.md | 9 +- test/generators/markdown/Type.md | 39 +++--- test/generators/markdown/mld.md | 3 +- 44 files changed, 281 insertions(+), 142 deletions(-) diff --git a/test/generators/markdown/Alias.X.md b/test/generators/markdown/Alias.X.md index e7dc9b97f6..898ce2802e 100644 --- a/test/generators/markdown/Alias.X.md +++ b/test/generators/markdown/Alias.X.md @@ -10,4 +10,5 @@ Module `Alias.X` > int -Module Foo__X documentation. This should appear in the documentation for the alias to this module 'X' +Module Foo__X documentation. This should appear in the documentation for the +alias to this module 'X' diff --git a/test/generators/markdown/Bugs.md b/test/generators/markdown/Bugs.md index e7454c4b4b..ee6dd795d6 100644 --- a/test/generators/markdown/Bugs.md +++ b/test/generators/markdown/Bugs.md @@ -14,4 +14,6 @@ Module `Bugs` > ?bar:'a -> unit -> unit -Triggers an assertion failure when [https://github.com/ocaml/odoc/issues/101](https://github.com/ocaml/odoc/issues/101) is not fixed. +Triggers an assertion failure when +[https://github.com/ocaml/odoc/issues/101](https://github.com/ocaml/odoc/issues/101) +is not fixed. diff --git a/test/generators/markdown/Bugs_post_406.md b/test/generators/markdown/Bugs_post_406.md index 6b7b6e3ce4..9245984a08 100644 --- a/test/generators/markdown/Bugs_post_406.md +++ b/test/generators/markdown/Bugs_post_406.md @@ -2,7 +2,8 @@ Bugs_post_406 Module `Bugs_post_406` -Let-open in class types, https://github.com/ocaml/odoc/issues/543 This was added to the language in 4.06 +Let-open in class types, https://github.com/ocaml/odoc/issues/543 This was +added to the language in 4.06 diff --git a/test/generators/markdown/Include.md b/test/generators/markdown/Include.md index f501f79229..46c19b8ce6 100644 --- a/test/generators/markdown/Include.md +++ b/test/generators/markdown/Include.md @@ -20,13 +20,16 @@ Module `Include` -###### module type [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md) +###### module type +[Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md) -include [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md) +include +[Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md) -###### module type [Not_inlined_and_opened](Include.module-type-Not_inlined_and_opened.md) +###### module type +[Not_inlined_and_opened](Include.module-type-Not_inlined_and_opened.md) @@ -38,7 +41,8 @@ include [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md) -###### module type [Dorminant_Module](Include.module-type-Dorminant_Module.md) +###### module type +[Dorminant_Module](Include.module-type-Dorminant_Module.md) diff --git a/test/generators/markdown/Include2.Y_include_synopsis.md b/test/generators/markdown/Include2.Y_include_synopsis.md index 8b09197382..ce0e611349 100644 --- a/test/generators/markdown/Include2.Y_include_synopsis.md +++ b/test/generators/markdown/Include2.Y_include_synopsis.md @@ -4,7 +4,8 @@ Y_include_synopsis Module `Include2.Y_include_synopsis` -The `include Y` below should have the synopsis from `Y`'s top-comment attached to it. +The `include Y` below should have the synopsis from `Y`'s top-comment +attached to it. diff --git a/test/generators/markdown/Include2.md b/test/generators/markdown/Include2.md index a2468d6fd6..1feb8a5d95 100644 --- a/test/generators/markdown/Include2.md +++ b/test/generators/markdown/Include2.md @@ -26,7 +26,8 @@ Top-comment of Y. ###### module [Y_include_synopsis](Include2.Y_include_synopsis.md) -The `include Y` below should have the synopsis from `Y`'s top-comment attached to it. +The `include Y` below should have the synopsis from `Y`'s top-comment +attached to it. diff --git a/test/generators/markdown/Include_sections.md b/test/generators/markdown/Include_sections.md index 606f50ec59..2e8763f431 100644 --- a/test/generators/markdown/Include_sections.md +++ b/test/generators/markdown/Include_sections.md @@ -22,7 +22,8 @@ Some text. # Second include -Let's include [`Something`](Include_sections.module-type-Something.md) a second time: the heading level should be shift here. +Let's include [`Something`](Include_sections.module-type-Something.md) a +second time: the heading level should be shift here. # Something 1 @@ -48,7 +49,8 @@ foo Some text. -And let's include it again, but without inlining it this time: the ToC shouldn't grow. +And let's include it again, but without inlining it this time: the ToC +shouldn't grow. diff --git a/test/generators/markdown/Labels.md b/test/generators/markdown/Labels.md index c2078fb6a0..ce7e903ee8 100644 --- a/test/generators/markdown/Labels.md +++ b/test/generators/markdown/Labels.md @@ -94,7 +94,7 @@ Attached to constructor -###### type v = { +###### type v = diff --git a/test/generators/markdown/Markup.md b/test/generators/markdown/Markup.md index 7d2d3355fe..cc3228217c 100644 --- a/test/generators/markdown/Markup.md +++ b/test/generators/markdown/Markup.md @@ -6,7 +6,8 @@ Here, we test the rendering of comment markup. # Sections -Let's get these done first, because sections will be used to break up the rest of this test. +Let's get these done first, because sections will be used to break up the +rest of this test. Besides the section heading above, there are also @@ -16,11 +17,14 @@ and ### Sub-subsection headings -but odoc has banned deeper headings. There are also title headings, but they are only allowed in mld files. +but odoc has banned deeper headings. There are also title headings, but they +are only allowed in mld files. ### Anchors -Sections can have attached [Anchors](#anchors), and it is possible to [link](#anchors) to them. Links to section headers should not be set in source code style. +Sections can have attached [Anchors](#anchors), and it is possible to +[link](#anchors) to them. Links to section headers should not be set in +source code style. #### Paragraph @@ -28,17 +32,26 @@ Individual paragraphs can have a heading. ##### Subparagraph -Parts of a longer paragraph that can be considered alone can also have headings. +Parts of a longer paragraph that can be considered alone can also have +headings. # Styling -This paragraph has some styled elements: **bold** and _italic_, **_bold italic_**, _emphasis_, __emphasis_ within emphasis_, **_bold italic_**, superscript, subscript. The line spacing should be enough for superscripts and subscripts not to look odd. +This paragraph has some styled elements: **bold** and _italic_, **_bold +italic_**, _emphasis_, __emphasis_ within emphasis_, **_bold italic_**, +superscript, subscript. The line spacing should be +enough for superscripts and subscripts not to look odd. -Note: _In italics _emphasis_ is rendered as normal text while _emphasis _in_ emphasis_ is rendered in italics._ _It also work the same in [links in italics with _emphasis _in_ emphasis_.](#)_ +Note: _In italics _emphasis_ is rendered as normal text while _emphasis _in_ +emphasis_ is rendered in italics._ _It also work the same in [links in +italics with _emphasis _in_ emphasis_.](#)_ `code` is a different kind of markup that doesn't allow nested markup. -It's possible for two markup elements to appear **next** _to_ each other and have a space, and appear **next**_to_ each other with no space. It doesn't matter **how** _much_ space it was in the source: in this sentence, it was two space characters. And in this one, there is **a** _newline_. +It's possible for two markup elements to appear **next** _to_ each other and +have a space, and appear **next**_to_ each other with no space. It doesn't +matter **how** _much_ space it was in the source: in this sentence, it was +two space characters. And in this one, there is **a** _newline_. This is also true between _non-_`code` markup _and_ `code`. @@ -46,9 +59,23 @@ Code can appear **inside `other` markup**. Its display shouldn't be affected. # Links and references -This is a [link](#). It sends you to the top of this page. Links can have markup inside them: [**bold**](#), [_italics_](#), [_emphasis_](#), [superscript](#), [subscript](#), and [`code`](#). Links can also be nested _[inside](#)_ markup. Links cannot be nested inside each other. This link has no replacement text: [#](#). The text is filled in by odoc. This is a shorthand link: [#](#). The text is also filled in by odoc in this case. - -This is a reference to [`foo`](#val-foo). References can have replacement text: [the value foo](#val-foo). Except for the special lookup support, references are pretty much just like links. The replacement text can have nested styles: [**bold**](#val-foo), [_italic_](#val-foo), [_emphasis_](#val-foo), [superscript](#val-foo), [subscript](#val-foo), and [`code`](#val-foo). It's also possible to surround a reference in a style: **[`foo`](#val-foo)**. References can't be nested inside references, and links and references can't be nested inside each other. +This is a [link](#). It sends you to the top of this page. Links can have +markup inside them: [**bold**](#), [_italics_](#), [_emphasis_](#), +[superscript](#), [subscript](#), and [`code`](#). +Links can also be nested _[inside](#)_ markup. Links cannot be nested inside +each other. This link has no replacement text: [#](#). The text is filled in +by odoc. This is a shorthand link: [#](#). The text is also filled in by odoc +in this case. + +This is a reference to [`foo`](#val-foo). References can have replacement +text: [the value foo](#val-foo). Except for the special lookup support, +references are pretty much just like links. The replacement text can have +nested styles: [**bold**](#val-foo), [_italic_](#val-foo), +[_emphasis_](#val-foo), [superscript](#val-foo), +[subscript](#val-foo), and [`code`](#val-foo). It's also possible +to surround a reference in a style: **[`foo`](#val-foo)**. References can't +be nested inside references, and links and references can't be nested inside +each other. # Preformatted text @@ -85,7 +112,8 @@ The main difference is these don't get syntax highlighting. 2. shorthand numbered list. -- Shorthand list items can span multiple lines, however trying to put two paragraphs into a shorthand list item using a double line break +- Shorthand list items can span multiple lines, however trying to put two + paragraphs into a shorthand list item using a double line break just creates a paragraph outside the list. @@ -126,7 +154,8 @@ The parser supports any ASCII-compatible encoding, in particuλar UTF-8. # Raw HTML -Raw HTML can be as inline elements into sentences. +Raw HTML can be as inline elements +into sentences.
diff --git a/test/generators/markdown/Module.md b/test/generators/markdown/Module.md index a13234fd54..e91ef0e152 100644 --- a/test/generators/markdown/Module.md +++ b/test/generators/markdown/Module.md @@ -10,7 +10,9 @@ Foo. > unit -The module needs at least one signature item, otherwise a bug causes the compiler to drop the module comment (above). See [https://caml.inria.fr/mantis/view.php?id=7701](https://caml.inria.fr/mantis/view.php?id=7701). +The module needs at least one signature item, otherwise a bug causes the +compiler to drop the module comment (above). See +[https://caml.inria.fr/mantis/view.php?id=7701](https://caml.inria.fr/mantis/view.php?id=7701). diff --git a/test/generators/markdown/Nested.F.md b/test/generators/markdown/Nested.F.md index 9fbdebcd09..d9984c3fa4 100644 --- a/test/generators/markdown/Nested.F.md +++ b/test/generators/markdown/Nested.F.md @@ -26,6 +26,7 @@ Some additional comments. ###### type t = -> [Arg1.t](Nested.F.argument-1-Arg1.md#type-t) * [Arg2.t](Nested.F.argument-2-Arg2.md#type-t) +> [Arg1.t](Nested.F.argument-1-Arg1.md#type-t) +> * [Arg2.t](Nested.F.argument-2-Arg2.md#type-t) Some type. diff --git a/test/generators/markdown/Ocamlary.Aliases.md b/test/generators/markdown/Ocamlary.Aliases.md index 0389bd3eee..df5c994a82 100644 --- a/test/generators/markdown/Ocamlary.Aliases.md +++ b/test/generators/markdown/Ocamlary.Aliases.md @@ -56,7 +56,8 @@ Let's imitate jst's layout. ### include of Foo -Just for giggle, let's see what happens when we include [`Foo`](Ocamlary.Aliases.Foo.md). +Just for giggle, let's see what happens when we include +[`Foo`](Ocamlary.Aliases.Foo.md). @@ -92,7 +93,8 @@ Just for giggle, let's see what happens when we include [`Foo`](Ocamlary.Aliases > [A.t](Ocamlary.Aliases.Foo.A.md#type-t) -And also, let's refer to [`A.t`](Ocamlary.Aliases.Foo.A.md#type-t) and [`Foo.B.id`](Ocamlary.Aliases.Foo.B.md#val-id) +And also, let's refer to [`A.t`](Ocamlary.Aliases.Foo.A.md#type-t) and +[`Foo.B.id`](Ocamlary.Aliases.Foo.B.md#val-id) diff --git a/test/generators/markdown/Ocamlary.CanonicalTest.Base_Tests.md b/test/generators/markdown/Ocamlary.CanonicalTest.Base_Tests.md index 4af17993a5..de7a6f74d2 100644 --- a/test/generators/markdown/Ocamlary.CanonicalTest.Base_Tests.md +++ b/test/generators/markdown/Ocamlary.CanonicalTest.Base_Tests.md @@ -20,13 +20,15 @@ Module `CanonicalTest.Base_Tests` ###### val foo : -> int [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> float [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) +> int [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> float +> [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) ###### val bar : -> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) +> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> 'a +> [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) diff --git a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md index 3fed7cc5d7..df7fd595e0 100644 --- a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md @@ -18,12 +18,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.CollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.CollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md b/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md index 8e0bc94e2f..64ea64131f 100644 --- a/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.md b/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.md index 23ef0effe4..6844d5a9fa 100644 --- a/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.md +++ b/test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.md @@ -20,7 +20,8 @@ This comment is for `collection`. -###### module [InnerModuleA](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md) +###### module +[InnerModuleA](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md) This comment is for `InnerModuleA`. diff --git a/test/generators/markdown/Ocamlary.IncludeInclude1.md b/test/generators/markdown/Ocamlary.IncludeInclude1.md index a9ce8a56b0..fcabe29698 100644 --- a/test/generators/markdown/Ocamlary.IncludeInclude1.md +++ b/test/generators/markdown/Ocamlary.IncludeInclude1.md @@ -6,8 +6,10 @@ Module `Ocamlary.IncludeInclude1` -###### module type [IncludeInclude2](Ocamlary.IncludeInclude1.module-type-IncludeInclude2.md) +###### module type +[IncludeInclude2](Ocamlary.IncludeInclude1.module-type-IncludeInclude2.md) -###### module [IncludeInclude2_M](Ocamlary.IncludeInclude1.IncludeInclude2_M.md) +###### module +[IncludeInclude2_M](Ocamlary.IncludeInclude1.IncludeInclude2_M.md) diff --git a/test/generators/markdown/Ocamlary.ModuleWithSignature.md b/test/generators/markdown/Ocamlary.ModuleWithSignature.md index 564f1a2254..025db37fd6 100644 --- a/test/generators/markdown/Ocamlary.ModuleWithSignature.md +++ b/test/generators/markdown/Ocamlary.ModuleWithSignature.md @@ -4,4 +4,5 @@ ModuleWithSignature Module `Ocamlary.ModuleWithSignature` -A plain module of a signature of [`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference) +A plain module of a signature of +[`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference) diff --git a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md index 54d97c07b3..ed0a568395 100644 --- a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md @@ -18,12 +18,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.Recollection.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.Recollection.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.Recollection.argument-1-C.InnerModuleA.md b/test/generators/markdown/Ocamlary.Recollection.argument-1-C.InnerModuleA.md index 60dbf22d92..4ebb36848f 100644 --- a/test/generators/markdown/Ocamlary.Recollection.argument-1-C.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.Recollection.argument-1-C.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.Recollection.argument-1-C.md b/test/generators/markdown/Ocamlary.Recollection.argument-1-C.md index 71b46a375b..4872455f74 100644 --- a/test/generators/markdown/Ocamlary.Recollection.argument-1-C.md +++ b/test/generators/markdown/Ocamlary.Recollection.argument-1-C.md @@ -20,7 +20,8 @@ This comment is for `collection`. -###### module [InnerModuleA](Ocamlary.Recollection.argument-1-C.InnerModuleA.md) +###### module +[InnerModuleA](Ocamlary.Recollection.argument-1-C.InnerModuleA.md) This comment is for `InnerModuleA`. diff --git a/test/generators/markdown/Ocamlary.md b/test/generators/markdown/Ocamlary.md index 422fb558b7..15412e6fb3 100644 --- a/test/generators/markdown/Ocamlary.md +++ b/test/generators/markdown/Ocamlary.md @@ -2,7 +2,8 @@ Ocamlary Module `Ocamlary` -This is an _interface_ with **all** of the _module system_ features. This documentation demonstrates: +This is an _interface_ with **all** of the _module system_ features. This +documentation demonstrates: - comment formatting @@ -49,7 +50,8 @@ David Sheets is the author. @author David Sheets -You may find more information about this HTML documentation renderer at [github.com/dsheets/ocamlary](https://github.com/dsheets/ocamlary). +You may find more information about this HTML documentation renderer at +[github.com/dsheets/ocamlary](https://github.com/dsheets/ocamlary). This is some verbatim text: @@ -75,7 +77,7 @@ Here is some superscript: x2 Here is some subscript: x0 -Here are some escaped brackets: { [ @ ] } +Here are some escaped brackets: [ @ ] Here is some _emphasis_ `followed by code`. @@ -139,11 +141,13 @@ A plain, empty module signature alias of ###### module [ModuleWithSignature](Ocamlary.ModuleWithSignature.md) -A plain module of a signature of [`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference) +A plain module of a signature of +[`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference) -###### module [ModuleWithSignatureAlias](Ocamlary.ModuleWithSignatureAlias.md) +###### module +[ModuleWithSignatureAlias](Ocamlary.ModuleWithSignatureAlias.md) A plain module with an alias signature @@ -161,7 +165,13 @@ There's a signature in a module in this signature. ###### module type [SuperSig](Ocamlary.module-type-SuperSig.md) -For a good time, see [`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) or [`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigB.md#subSig) or [`SuperSig.EmptySig`](Ocamlary.module-type-SuperSig.module-type-EmptySig.md). Section [Section 9000](#s9000) is also interesting. [EmptySig](#emptySig) is the section and [`EmptySig`](Ocamlary.module-type-EmptySig.md) is the module signature. +For a good time, see +[`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) or +[`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigB.md#subSig) or +[`SuperSig.EmptySig`](Ocamlary.module-type-SuperSig.module-type-EmptySig.md). +Section [Section 9000](#s9000) is also interesting. [EmptySig](#emptySig) is +the section and [`EmptySig`](Ocamlary.module-type-EmptySig.md) is the module +signature. @@ -197,7 +207,8 @@ Unary exception constructor over binary tuple ###### exception EmptySig -[`EmptySig`](Ocamlary.module-type-EmptySig.md) is a module and [`EmptySig`](#exception-EmptySig) is this exception. +[`EmptySig`](Ocamlary.module-type-EmptySig.md) is a module and +[`EmptySig`](#exception-EmptySig) is this exception. @@ -213,7 +224,8 @@ Unary exception constructor over binary tuple > 'a -> 'b -[`a_function`](#type-a_function) is this type and [`a_function`](#val-a_function) is the value below. +[`a_function`](#type-a_function) is this type and +[`a_function`](#val-a_function) is the value below. @@ -232,7 +244,8 @@ This is `a_function` with param and return type. ###### val fun_fun_fun : > -> ( ( int, int ) [a_function](#type-a_function), ( unit, unit ) [a_function](#type-a_function) ) [a_function](#type-a_function) +> ( ( int, int ) [a_function](#type-a_function), ( unit, unit ) +> [a_function](#type-a_function) ) [a_function](#type-a_function) @@ -410,7 +423,8 @@ module type of -###### module type [RecollectionModule](Ocamlary.module-type-RecollectionModule.md) +###### module type +[RecollectionModule](Ocamlary.module-type-RecollectionModule.md) @@ -434,7 +448,8 @@ This comment is for `FunctorTypeOf`. -###### module type [IncludeModuleType](Ocamlary.module-type-IncludeModuleType.md) +###### module type +[IncludeModuleType](Ocamlary.module-type-IncludeModuleType.md) This comment is for `IncludeModuleType`. @@ -454,7 +469,7 @@ This comment is for `IncludeModuleType`. -###### type record = { +###### type record = @@ -474,7 +489,7 @@ This comment is also for `record`. -###### type mutable_record = { +###### type mutable_record = @@ -496,7 +511,7 @@ This comment is also for `record`. -###### type universe_record = { +###### type universe_record = @@ -536,7 +551,7 @@ This comment is also for `variant`. -###### type poly_variant = [ +###### type poly_variant = @@ -606,7 +621,8 @@ This comment is for `alias`. ###### type tuple = -> ([alias](#type-alias) * [alias](#type-alias)) * [alias](#type-alias) * ([alias](#type-alias) * [alias](#type-alias)) +> ([alias](#type-alias) * [alias](#type-alias)) * [alias](#type-alias) +> * ([alias](#type-alias) * [alias](#type-alias)) This comment is for `tuple`. @@ -634,7 +650,7 @@ This comment is for `variant_alias`. -###### type record_alias = [record](#type-record) = { +###### type record_alias = [record](#type-record) = @@ -648,7 +664,7 @@ This comment is for `record_alias`. -###### type poly_variant_union = [ +###### type poly_variant_union = @@ -662,7 +678,7 @@ This comment is for `poly_variant_union`. -###### type 'a poly_poly_variant = [ +###### type 'a poly_poly_variant = @@ -670,7 +686,7 @@ This comment is for `poly_variant_union`. -###### type ('a, 'b) bin_poly_poly_variant = [ +###### type ('a, 'b) bin_poly_poly_variant = @@ -684,37 +700,38 @@ This comment is for `poly_variant_union`. ###### type 'a open_poly_variant = -> [> `TagA ] as 'a +> [> `TagA as 'a ###### type 'a open_poly_variant2 = -> [> `ConstrB of int ] as 'a +> [> `ConstrB of int as 'a ###### type 'a open_poly_variant_alias = -> 'a [open_poly_variant](#type-open_poly_variant) [open_poly_variant2](#type-open_poly_variant2) +> 'a [open_poly_variant](#type-open_poly_variant) +> [open_poly_variant2](#type-open_poly_variant2) ###### type 'a poly_fun = -> [> `ConstrB of int ] as 'a -> 'a +> [> `ConstrB of int as 'a -> 'a ###### type 'a poly_fun_constraint = -> 'a -> 'a constraint 'a = [> `TagA ] +> 'a -> 'a constraint 'a = [> `TagA ###### type 'a closed_poly_variant = -> [< `One | `Two ] as 'a +> [< `One | `Two as 'a @@ -724,7 +741,7 @@ This comment is for `poly_variant_union`. -###### type nested_poly_variant = [ +###### type nested_poly_variant = @@ -744,7 +761,8 @@ This comment is for `poly_variant_union`. -###### type ('a, 'b) full_gadt_alias = ( 'a, 'b ) [full_gadt](#type-full_gadt) = +###### type ('a, 'b) full_gadt_alias = ( 'a, 'b ) +[full_gadt](#type-full_gadt) = @@ -778,7 +796,8 @@ This comment is for `full_gadt_alias`. -> | ExistGadtTag : ( 'a -> 'b ) -> 'a [partial_gadt_alias](#type-partial_gadt_alias) +> | ExistGadtTag : ( 'a -> 'b ) -> 'a +> [partial_gadt_alias](#type-partial_gadt_alias) This comment is for `partial_gadt_alias`. @@ -802,9 +821,11 @@ This comment is for [`Exn_arrow`](#exception-Exn_arrow). > | B_ish of [mutual_constr_b](#type-mutual_constr_b) -This comment is between [`mutual_constr_a`](#type-mutual_constr_a) and [`mutual_constr_b`](#type-mutual_constr_b). +This comment is between [`mutual_constr_a`](#type-mutual_constr_a) and +[`mutual_constr_b`](#type-mutual_constr_b). -This comment is for [`mutual_constr_a`](#type-mutual_constr_a) then [`mutual_constr_b`](#type-mutual_constr_b). +This comment is for [`mutual_constr_a`](#type-mutual_constr_a) then +[`mutual_constr_b`](#type-mutual_constr_b). @@ -820,7 +841,8 @@ This comment is for [`mutual_constr_a`](#type-mutual_constr_a) then [`mutual_con This comment must be here for the next to associate correctly. -This comment is for [`mutual_constr_b`](#type-mutual_constr_b) then [`mutual_constr_a`](#type-mutual_constr_a). +This comment is for [`mutual_constr_b`](#type-mutual_constr_b) then +[`mutual_constr_a`](#type-mutual_constr_a). @@ -1192,16 +1214,18 @@ A brown paper package tied up with string # Trying the {!modules: ...} command. -With ocamldoc, toplevel units will be linked and documented, while submodules will behave as simple references. +With ocamldoc, toplevel units will be linked and documented, while submodules +will behave as simple references. -With odoc, everything should be resolved (and linked) but only toplevel units will be documented. +With odoc, everything should be resolved (and linked) but only toplevel units +will be documented. @[`Dep1.X`](Ocamlary.Dep1.X.md) @[`Ocamlary.IncludeInclude1`](Ocamlary.IncludeInclude1.md) -@[`Ocamlary`]() -This is an _interface_ with **all** of the _module system_ features. This documentation demonstrates: +@[`Ocamlary`]() This is an _interface_ with **all** of the _module system_ +features. This documentation demonstrates: ### Weirder usages involving module types @@ -1215,7 +1239,12 @@ This is an _interface_ with **all** of the _module system_ features. This docume ###### module [CanonicalTest](Ocamlary.CanonicalTest.md) -Some ref to [`CanonicalTest.Base_Tests.C.t`](Ocamlary.CanonicalTest.Base_Tests.C.md#type-t) and [`CanonicalTest.Base_Tests.L.id`](Ocamlary.CanonicalTest.Base.List.md#val-id). But also to [`CanonicalTest.Base.List`](Ocamlary.CanonicalTest.Base.List.md) and [`CanonicalTest.Base.List.t`](Ocamlary.CanonicalTest.Base.List.md#type-t) +Some ref to +[`CanonicalTest.Base_Tests.C.t`](Ocamlary.CanonicalTest.Base_Tests.C.md#type-t) +and +[`CanonicalTest.Base_Tests.L.id`](Ocamlary.CanonicalTest.Base.List.md#val-id). +But also to [`CanonicalTest.Base.List`](Ocamlary.CanonicalTest.Base.List.md) +and [`CanonicalTest.Base.List.t`](Ocamlary.CanonicalTest.Base.List.md#type-t) # Aliases again @@ -1229,7 +1258,8 @@ Let's imitate jst's layout. I can refer to -- `{!section:indexmodules}` : [Trying the {!modules: ...} command.](#indexmodules) +- `{!section:indexmodules}` : [Trying the {!modules: ...} + command.](#indexmodules) - `{!aliases}` : [Aliases again](#aliases) @@ -1237,7 +1267,8 @@ I can refer to But also to things in submodules: -- `{!section:SuperSig.SubSigA.subSig}` : [`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) +- `{!section:SuperSig.SubSigA.subSig}` : + [`subSig`](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) - `{!Aliases.incl}` : [`incl`](Ocamlary.Aliases.md#incl) @@ -1251,7 +1282,8 @@ And just to make sure we do not mess up: - `{{!aliases}B}` : [B](#aliases) -- `{{!section:SuperSig.SubSigA.subSig}C}` : [C](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) +- `{{!section:SuperSig.SubSigA.subSig}C}` : + [C](Ocamlary.module-type-SuperSig.module-type-SubSigA.md#subSig) - `{{!Aliases.incl}D}` : [D](Ocamlary.Aliases.md#incl) @@ -1279,16 +1311,20 @@ Here goes: ###### module [Only_a_module](Ocamlary.Only_a_module.md) -- `{!Only_a_module.t}` : [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) +- `{!Only_a_module.t}` : + [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) -- `{!module-Only_a_module.t}` : [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) +- `{!module-Only_a_module.t}` : + [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) -- `{!module-Only_a_module.type-t}` : [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) +- `{!module-Only_a_module.type-t}` : + [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) -- `{!type:Only_a_module.t}` : [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) +- `{!type:Only_a_module.t}` : + [`Only_a_module.t`](Ocamlary.Only_a_module.md#type-t) diff --git a/test/generators/markdown/Ocamlary.module-type-A.Q.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-A.Q.InnerModuleA.md index 066b8a008a..888457b937 100644 --- a/test/generators/markdown/Ocamlary.module-type-A.Q.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-A.Q.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-A.Q.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-A.Q.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-A.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-A.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-B.Q.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-B.Q.InnerModuleA.md index 20ed2ed783..8ba3ae9960 100644 --- a/test/generators/markdown/Ocamlary.module-type-B.Q.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-B.Q.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-B.Q.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-B.Q.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-B.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-B.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-C.Q.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-C.Q.InnerModuleA.md index d54c480658..7fb5375ddc 100644 --- a/test/generators/markdown/Ocamlary.module-type-C.Q.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-C.Q.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-C.Q.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-C.Q.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-C.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-C.Q.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-COLLECTION.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-COLLECTION.InnerModuleA.md index fed0d24364..4cb1c304e0 100644 --- a/test/generators/markdown/Ocamlary.module-type-COLLECTION.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-COLLECTION.InnerModuleA.md @@ -18,12 +18,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-COLLECTION.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-COLLECTION.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-COLLECTION.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-COLLECTION.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-MMM.C.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-MMM.C.InnerModuleA.md index 011207d5a0..213099c295 100644 --- a/test/generators/markdown/Ocamlary.module-type-MMM.C.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-MMM.C.InnerModuleA.md @@ -20,12 +20,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-MMM.C.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-MMM.C.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-MMM.C.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-MMM.C.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-NestedInclude1.md b/test/generators/markdown/Ocamlary.module-type-NestedInclude1.md index f06831974c..97726c9f67 100644 --- a/test/generators/markdown/Ocamlary.module-type-NestedInclude1.md +++ b/test/generators/markdown/Ocamlary.module-type-NestedInclude1.md @@ -6,4 +6,5 @@ Module type `Ocamlary.NestedInclude1` -###### module type [NestedInclude2](Ocamlary.module-type-NestedInclude1.module-type-NestedInclude2.md) +###### module type +[NestedInclude2](Ocamlary.module-type-NestedInclude1.module-type-NestedInclude2.md) diff --git a/test/generators/markdown/Ocamlary.module-type-RecollectionModule.InnerModuleA.md b/test/generators/markdown/Ocamlary.module-type-RecollectionModule.InnerModuleA.md index 23d4364985..8b2ecda941 100644 --- a/test/generators/markdown/Ocamlary.module-type-RecollectionModule.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.module-type-RecollectionModule.InnerModuleA.md @@ -18,12 +18,14 @@ This comment is for `t`. -###### module [InnerModuleA'](Ocamlary.module-type-RecollectionModule.InnerModuleA.InnerModuleA'.md) +###### module +[InnerModuleA'](Ocamlary.module-type-RecollectionModule.InnerModuleA.InnerModuleA'.md) This comment is for `InnerModuleA'`. -###### module type [InnerModuleTypeA'](Ocamlary.module-type-RecollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md) +###### module type +[InnerModuleTypeA'](Ocamlary.module-type-RecollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md) This comment is for `InnerModuleTypeA'`. diff --git a/test/generators/markdown/Ocamlary.module-type-RecollectionModule.md b/test/generators/markdown/Ocamlary.module-type-RecollectionModule.md index 3ce0bf479e..c5ae6dad29 100644 --- a/test/generators/markdown/Ocamlary.module-type-RecollectionModule.md +++ b/test/generators/markdown/Ocamlary.module-type-RecollectionModule.md @@ -18,7 +18,8 @@ Module type `Ocamlary.RecollectionModule` -###### module [InnerModuleA](Ocamlary.module-type-RecollectionModule.InnerModuleA.md) +###### module +[InnerModuleA](Ocamlary.module-type-RecollectionModule.InnerModuleA.md) This comment is for `InnerModuleA`. diff --git a/test/generators/markdown/Ocamlary.module-type-SigForMod.Inner.md b/test/generators/markdown/Ocamlary.module-type-SigForMod.Inner.md index 2fadb0ac77..2aee21fad4 100644 --- a/test/generators/markdown/Ocamlary.module-type-SigForMod.Inner.md +++ b/test/generators/markdown/Ocamlary.module-type-SigForMod.Inner.md @@ -8,4 +8,5 @@ Module `SigForMod.Inner` -###### module type [Empty](Ocamlary.module-type-SigForMod.Inner.module-type-Empty.md) +###### module type +[Empty](Ocamlary.module-type-SigForMod.Inner.module-type-Empty.md) diff --git a/test/generators/markdown/Ocamlary.module-type-SuperSig.md b/test/generators/markdown/Ocamlary.module-type-SuperSig.md index 76a9c9ee27..cc52b8ba66 100644 --- a/test/generators/markdown/Ocamlary.module-type-SuperSig.md +++ b/test/generators/markdown/Ocamlary.module-type-SuperSig.md @@ -6,15 +6,18 @@ Module type `Ocamlary.SuperSig` -###### module type [SubSigA](Ocamlary.module-type-SuperSig.module-type-SubSigA.md) +###### module type +[SubSigA](Ocamlary.module-type-SuperSig.module-type-SubSigA.md) -###### module type [SubSigB](Ocamlary.module-type-SuperSig.module-type-SubSigB.md) +###### module type +[SubSigB](Ocamlary.module-type-SuperSig.module-type-SubSigB.md) -###### module type [EmptySig](Ocamlary.module-type-SuperSig.module-type-EmptySig.md) +###### module type +[EmptySig](Ocamlary.module-type-SuperSig.module-type-EmptySig.md) @@ -22,4 +25,5 @@ Module type `Ocamlary.SuperSig` -###### module type [SuperSig](Ocamlary.module-type-SuperSig.module-type-SuperSig.md) +###### module type +[SuperSig](Ocamlary.module-type-SuperSig.module-type-SuperSig.md) diff --git a/test/generators/markdown/Ocamlary.module-type-SuperSig.module-type-SubSigA.md b/test/generators/markdown/Ocamlary.module-type-SuperSig.module-type-SubSigA.md index adcc45394c..5dd0dd483f 100644 --- a/test/generators/markdown/Ocamlary.module-type-SuperSig.module-type-SubSigA.md +++ b/test/generators/markdown/Ocamlary.module-type-SuperSig.module-type-SubSigA.md @@ -14,4 +14,5 @@ Module type `SuperSig.SubSigA` -###### module [SubSigAMod](Ocamlary.module-type-SuperSig.module-type-SubSigA.SubSigAMod.md) +###### module +[SubSigAMod](Ocamlary.module-type-SuperSig.module-type-SubSigA.SubSigAMod.md) diff --git a/test/generators/markdown/Ocamlary.module-type-ToInclude.md b/test/generators/markdown/Ocamlary.module-type-ToInclude.md index 9583e397a3..f4e70e5a10 100644 --- a/test/generators/markdown/Ocamlary.module-type-ToInclude.md +++ b/test/generators/markdown/Ocamlary.module-type-ToInclude.md @@ -10,4 +10,5 @@ Module type `Ocamlary.ToInclude` -###### module type [IncludedB](Ocamlary.module-type-ToInclude.module-type-IncludedB.md) +###### module type +[IncludedB](Ocamlary.module-type-ToInclude.module-type-IncludedB.md) diff --git a/test/generators/markdown/Recent.md b/test/generators/markdown/Recent.md index 6724ac99e2..27114aefb2 100644 --- a/test/generators/markdown/Recent.md +++ b/test/generators/markdown/Recent.md @@ -36,7 +36,7 @@ _bar_ -> | E of { +> | E of @@ -58,7 +58,7 @@ foo -> | C : { +> | C : @@ -68,7 +68,7 @@ foo -###### type polymorphic_variant = [ +###### type polymorphic_variant = @@ -108,7 +108,7 @@ bar -> | X : [< `X of & 'a & int * float ] -> [empty_conj](#type-empty_conj) +> | X : [< `X of & 'a & int * float -> [empty_conj](#type-empty_conj) @@ -116,19 +116,19 @@ bar -> | X : [< `X of int & [< `B of int & float ] ] -> [conj](#type-conj) +> | X : [< `X of int & [< `B of int & float -> [conj](#type-conj) ###### val empty_conj : -> [< `X of & 'a & int * float ] +> [< `X of & 'a & int * float ###### val conj : -> [< `X of int & [< `B of int & float ] ] +> [< `X of int & [< `B of int & float diff --git a/test/generators/markdown/Recent.module-type-PolyS.md b/test/generators/markdown/Recent.module-type-PolyS.md index d3e91bbd3b..64d1060fb2 100644 --- a/test/generators/markdown/Recent.module-type-PolyS.md +++ b/test/generators/markdown/Recent.module-type-PolyS.md @@ -6,7 +6,7 @@ Module type `Recent.PolyS` -###### type t = [ +###### type t = diff --git a/test/generators/markdown/Section.md b/test/generators/markdown/Section.md index b825da564b..10bcca8174 100644 --- a/test/generators/markdown/Section.md +++ b/test/generators/markdown/Section.md @@ -30,4 +30,6 @@ Foo bar. # _This_ `section` **title** has markup -But links are impossible thanks to the parser, so we never have trouble rendering a section title in a table of contents – no link will be nested inside another link. +But links are impossible thanks to the parser, so we never have trouble +rendering a section title in a table of contents – no link will be nested +inside another link. diff --git a/test/generators/markdown/Stop.md b/test/generators/markdown/Stop.md index f075c038c7..10df64d1f7 100644 --- a/test/generators/markdown/Stop.md +++ b/test/generators/markdown/Stop.md @@ -12,11 +12,17 @@ This test cases exercises stop comments. This is normal commented text. -The next value is `bar`, and it should be missing from the documentation. There is also an entire module, `M`, which should also be hidden. It contains a nested stop comment, but that stop comment should not turn documentation back on in this outer module, because stop comments respect scope. +The next value is `bar`, and it should be missing from the documentation. +There is also an entire module, `M`, which should also be hidden. It contains +a nested stop comment, but that stop comment should not turn documentation +back on in this outer module, because stop comments respect scope. Documentation is on again. -Now, we have a nested module, and it has a stop comment between its two items. We want to see that the first item is displayed, but the second is missing, and the stop comment disables documenation only in that module, and not in this outer module. +Now, we have a nested module, and it has a stop comment between its two +items. We want to see that the first item is displayed, but the second is +missing, and the stop comment disables documenation only in that module, and +not in this outer module. diff --git a/test/generators/markdown/Stop_dead_link_doc.md b/test/generators/markdown/Stop_dead_link_doc.md index e3580a5319..fcd0f48f6e 100644 --- a/test/generators/markdown/Stop_dead_link_doc.md +++ b/test/generators/markdown/Stop_dead_link_doc.md @@ -20,7 +20,7 @@ Module `Stop_dead_link_doc` -> | Bar of { +> | Bar of diff --git a/test/generators/markdown/Toplevel_comments.Comments_on_open.md b/test/generators/markdown/Toplevel_comments.Comments_on_open.md index 08bf35d202..6389c8bf65 100644 --- a/test/generators/markdown/Toplevel_comments.Comments_on_open.md +++ b/test/generators/markdown/Toplevel_comments.Comments_on_open.md @@ -10,4 +10,5 @@ Module `Toplevel_comments.Comments_on_open` ## Section -Comments attached to open are treated as floating comments. Referencing [Section](#sec) [`M.t`](Toplevel_comments.Comments_on_open.M.md#type-t) works +Comments attached to open are treated as floating comments. Referencing +[Section](#sec) [`M.t`](Toplevel_comments.Comments_on_open.M.md#type-t) works diff --git a/test/generators/markdown/Toplevel_comments.Ref_in_synopsis.md b/test/generators/markdown/Toplevel_comments.Ref_in_synopsis.md index 5b43ef08b5..40045252ec 100644 --- a/test/generators/markdown/Toplevel_comments.Ref_in_synopsis.md +++ b/test/generators/markdown/Toplevel_comments.Ref_in_synopsis.md @@ -6,7 +6,8 @@ Module `Toplevel_comments.Ref_in_synopsis` [`t`](#type-t). -This reference should resolve in the context of this module, even when used as a synopsis. +This reference should resolve in the context of this module, even when used +as a synopsis. diff --git a/test/generators/markdown/Toplevel_comments.md b/test/generators/markdown/Toplevel_comments.md index fb85045525..79e2bf24f0 100644 --- a/test/generators/markdown/Toplevel_comments.md +++ b/test/generators/markdown/Toplevel_comments.md @@ -2,7 +2,8 @@ Toplevel_comments Module `Toplevel_comments` -A doc comment at the beginning of a module is considered to be that module's doc. +A doc comment at the beginning of a module is considered to be that module's +doc. @@ -24,13 +25,15 @@ Doc of `Include_inline`, part 1. -###### module type [Include_inline_T](Toplevel_comments.module-type-Include_inline_T.md) +###### module type +[Include_inline_T](Toplevel_comments.module-type-Include_inline_T.md) Doc of `T`, part 2. -###### module type [Include_inline_T'](Toplevel_comments.module-type-Include_inline_T'.md) +###### module type +[Include_inline_T'](Toplevel_comments.module-type-Include_inline_T'.md) Doc of `Include_inline_T'`, part 1. diff --git a/test/generators/markdown/Type.md b/test/generators/markdown/Type.md index 2dc7d133ce..823889172f 100644 --- a/test/generators/markdown/Type.md +++ b/test/generators/markdown/Type.md @@ -92,20 +92,25 @@ Some _documentation_. > > [labeled_higher_order](#type-labeled_higher_order) -> -> [ `Bar | `Baz of [triple](#type-triple) ] -> +> `Bar | `Baz of +> [triple](#type-triple) -> > [pair](#type-pair) -> -> [labeled](#type-labeled) -> +> [labeled](#type-labeled) +> -> > [higher_order](#type-higher_order) -> > ( string -> int ) -> -> (int * float * char * string * char * unit) option -> +> (int +> * float * char * string * char * unit) option +> -> > [nested_pair](#type-nested_pair) -> > [arrow](#type-arrow) -> -> string -> +> string +> -> > [nested_pair](#type-nested_pair) array -###### type variant_e = { +###### type variant_e = @@ -141,7 +146,7 @@ _bar_ -###### type variant_c = { +###### type variant_c = @@ -181,7 +186,7 @@ _bar_ -###### type record = { +###### type record = @@ -209,7 +214,7 @@ _bar_ -###### type polymorphic_variant = [ +###### type polymorphic_variant = @@ -229,7 +234,7 @@ _bar_ -###### type polymorphic_variant_extension = [ +###### type polymorphic_variant_extension = @@ -241,7 +246,7 @@ _bar_ -###### type nested_polymorphic_variant = [ +###### type nested_polymorphic_variant = @@ -279,7 +284,9 @@ _bar_ ###### type module_substitution = -> (module [X](Type.module-type-X.md) with type [t](Type.module-type-X.md#type-t) = int and type [u](Type.module-type-X.md#type-u) = unit) +> (module [X](Type.module-type-X.md) with type +> [t](Type.module-type-X.md#type-t) = int and type +> [u](Type.module-type-X.md#type-u) = unit) @@ -319,31 +326,31 @@ _bar_ ###### type 'a exact_variant = -> 'a constraint 'a = [ `A | `B of int ] +> 'a constraint 'a = `A | `B of int ###### type 'a lower_variant = -> 'a constraint 'a = [> `A | `B of int ] +> 'a constraint 'a = [> `A | `B of int ###### type 'a any_variant = -> 'a constraint 'a = [> ] +> 'a constraint 'a = [> ###### type 'a upper_variant = -> 'a constraint 'a = [< `A | `B of int ] +> 'a constraint 'a = [< `A | `B of int ###### type 'a named_variant = -> 'a constraint 'a = [< [polymorphic_variant](#type-polymorphic_variant) ] +> 'a constraint 'a = [< [polymorphic_variant](#type-polymorphic_variant) diff --git a/test/generators/markdown/mld.md b/test/generators/markdown/mld.md index 3e0cb7a46c..a99de7ddc8 100644 --- a/test/generators/markdown/mld.md +++ b/test/generators/markdown/mld.md @@ -2,7 +2,8 @@ mld Mld Page -This is an `.mld` file. It doesn't have an auto-generated title, like modules and other pages generated fully by odoc do. +This is an `.mld` file. It doesn't have an auto-generated title, like modules +and other pages generated fully by odoc do. It will have a TOC generated from section headings.