From b0cc54332d2db61a13a9d48951c274f53331b90d Mon Sep 17 00:00:00 2001 From: lubegasimon Date: Wed, 15 Sep 2021 18:26:39 +0300 Subject: [PATCH] Promote tests, don't generate links in markdown by default Signed-off-by: lubegasimon --- test/generators/markdown/Bugs.md | 2 +- test/generators/markdown/Include.md | 10 +- test/generators/markdown/Labels.md | 36 +-- test/generators/markdown/Markup.md | 29 ++- test/generators/markdown/Module.md | 3 +- ...ectionModule.InnerModuleA.InnerModuleA'.md | 2 +- .../Ocamlary.CollectionModule.InnerModuleA.md | 2 +- .../markdown/Ocamlary.CollectionModule.md | 2 +- .../markdown/Ocamlary.FunctorTypeOf.md | 8 +- ...Recollection.InnerModuleA.InnerModuleA'.md | 2 +- .../Ocamlary.Recollection.InnerModuleA.md | 2 +- .../markdown/Ocamlary.Recollection.md | 10 +- test/generators/markdown/Ocamlary.md | 206 +++++++++--------- test/generators/markdown/Recent.md | 10 +- test/generators/markdown/Type.md | 38 ++-- 15 files changed, 176 insertions(+), 186 deletions(-) diff --git a/test/generators/markdown/Bugs.md b/test/generators/markdown/Bugs.md index f3be52086f..894cabc861 100644 --- a/test/generators/markdown/Bugs.md +++ b/test/generators/markdown/Bugs.md @@ -9,6 +9,6 @@ Bugs ######   val foo : ?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 is not fixed. diff --git a/test/generators/markdown/Include.md b/test/generators/markdown/Include.md index 586ee38fa8..10926d22b2 100644 --- a/test/generators/markdown/Include.md +++ b/test/generators/markdown/Include.md @@ -66,7 +66,7 @@ end ######   module type Inherent_Module = sig -######        val a : [t](#type-t) +######        val a : t end @@ -81,7 +81,7 @@ end -######        val a : [u](#type-u) +######        val a : u end @@ -91,7 +91,7 @@ end -######   val a : [u](#type-u) +######   val a : u IncludeNot_inlined @@ -126,7 +126,7 @@ IncludeInherent_Module Module type `` Include.Inherent_Module`` -######   val a : [t](#type-t) +######   val a : t IncludeDorminant_Module @@ -135,5 +135,5 @@ IncludeDorminant_Module -######   val a : [u](#type-u) +######   val a : u diff --git a/test/generators/markdown/Labels.md b/test/generators/markdown/Labels.md index cfebf6cdb1..f32cb67995 100644 --- a/test/generators/markdown/Labels.md +++ b/test/generators/markdown/Labels.md @@ -23,7 +23,7 @@ Attached to type -######   val f : [t](#type-t) +######   val f : t Attached to value @@ -31,7 +31,7 @@ Attached to value -######   val e : unit -> [t](#type-t) +######   val e : unit -> t Attached to external @@ -77,7 +77,7 @@ Attached to exception -######   type [x](#type-x) += +######   type x += ######        | X @@ -100,7 +100,7 @@ Attached to module subst -######   type s := [t](#type-t) +######   type s := t Attached to type subst @@ -125,7 +125,7 @@ Attached to type subst ######   type v = { -######        `` f : [t](#type-t); +######        `` f : t; `` Attached to field @@ -139,31 +139,31 @@ Attached to type subst Testing that labels can be referenced -- [Attached to unit](#L1) +- Attached to unit -- [Attached to nothing](#L2) +- Attached to nothing -- [Attached to module](#L3) +- Attached to module -- [Attached to type](#L4) +- Attached to type -- [Attached to value](#L5) +- Attached to value -- [Attached to class](#L6) +- Attached to class -- [Attached to class type](#L7) +- Attached to class type -- [Attached to exception](#L8) +- Attached to exception -- [Attached to extension](#L9) +- Attached to extension -- [Attached to module subst](#L10) +- Attached to module subst -- [Attached to type subst](#L11) +- Attached to type subst -- [Attached to constructor](#L12) +- Attached to constructor -- [Attached to field](#L13) +- Attached to field LabelsA diff --git a/test/generators/markdown/Markup.md b/test/generators/markdown/Markup.md index 961e7e19be..323ffc14a5 100644 --- a/test/generators/markdown/Markup.md +++ b/test/generators/markdown/Markup.md @@ -36,7 +36,7 @@ but odoc has banned deeper headings. There are also title headings, but they are ### 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, and it is possible to link to them. Links to section headers should not be set in source code style. @@ -67,8 +67,7 @@ _emphasis_, __emphasis_ within emphasis_, **_bold italic_**, superscript, s 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](#)[ ](#)[.](#)_ +_It also work the same in links in italics with _emphasis _in_ emphasis_._ `` code @@ -92,17 +91,17 @@ 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: , , , -[super](#), [sub](#), and . 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 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), [super -script](#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 reference to `` foo +`` . References can have replacement text: the value foo. Except for the special lookup support, references are pretty much just like links. The replacement text can have nested styles: +**bold**, _italic_, _emphasis_, superscript, subscript, and +`` code +`` . It's also possible to surround a reference in a style: **`` foo`` **. References can't be nested inside references, and links and references can't be nested inside each other. @@ -165,8 +164,8 @@ can use explicitly-delimited lists. - and can include references -- [`` foo -`` ](#val-foo) +- `` foo +`` @@ -245,7 +244,7 @@ Each comment can end with zero or more tags. Here are some examples: -@see [#](#) : this url +@see # : this url diff --git a/test/generators/markdown/Module.md b/test/generators/markdown/Module.md index 47c88761ab..e3d0224b31 100644 --- a/test/generators/markdown/Module.md +++ b/test/generators/markdown/Module.md @@ -8,8 +8,7 @@ Foo. ######   val 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. diff --git a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md index 2b2e8cc7fd..07b4eaa0f7 100644 --- a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md +++ b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md @@ -7,7 +7,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md index 874c53053b..5f94a409bf 100644 --- a/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md @@ -50,7 +50,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.CollectionModule.md b/test/generators/markdown/Ocamlary.CollectionModule.md index 163e95b4dc..864399c6d2 100644 --- a/test/generators/markdown/Ocamlary.CollectionModule.md +++ b/test/generators/markdown/Ocamlary.CollectionModule.md @@ -89,7 +89,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.FunctorTypeOf.md b/test/generators/markdown/Ocamlary.FunctorTypeOf.md index 48b8494e44..5a97ce5338 100644 --- a/test/generators/markdown/Ocamlary.FunctorTypeOf.md +++ b/test/generators/markdown/Ocamlary.FunctorTypeOf.md @@ -48,7 +48,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -149,7 +149,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -217,7 +217,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -257,7 +257,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md index 3f7eb98bef..3b2985d57d 100644 --- a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md +++ b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md @@ -7,7 +7,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md index 071fff525a..011d6a50cb 100644 --- a/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md +++ b/test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md @@ -50,7 +50,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.Recollection.md b/test/generators/markdown/Ocamlary.Recollection.md index 6735650be6..7c0d0e9dc3 100644 --- a/test/generators/markdown/Ocamlary.Recollection.md +++ b/test/generators/markdown/Ocamlary.Recollection.md @@ -43,7 +43,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -172,7 +172,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -240,7 +240,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -280,7 +280,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -355,7 +355,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . diff --git a/test/generators/markdown/Ocamlary.md b/test/generators/markdown/Ocamlary.md index 3fe9476749..dec1ac5490 100644 --- a/test/generators/markdown/Ocamlary.md +++ b/test/generators/markdown/Ocamlary.md @@ -48,8 +48,7 @@ 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. @@ -316,7 +315,7 @@ end For a good time, see `` SuperSig`` .SubSigA.subSig or `` SuperSig `` .SubSigB.subSig or `` SuperSig.EmptySig -`` . Section [Section 9000](#s9000) is also interesting. [EmptySig](#emptySig) is the section and +`` . Section Section 9000 is also interesting. EmptySig is the section and `` EmptySig `` is the module signature. @@ -370,8 +369,8 @@ Unary exception constructor over binary tuple ######   exception EmptySig -`` EmptySig`` is a module and [`` EmptySig -`` ](#exception-EmptySig) is this exception. +`` EmptySig`` is a module and `` EmptySig +`` is this exception. @@ -379,8 +378,8 @@ Unary exception constructor over binary tuple ######   exception EmptySigAlias -[`` EmptySigAlias -`` ](#exception-EmptySigAlias) is this exception. +`` EmptySigAlias +`` is this exception. @@ -392,8 +391,8 @@ Unary exception constructor over binary tuple ######   type ('a, 'b) a_function = 'a -> 'b -[`` a_function`` ](#type-a_function) is this type and [`` a_function -`` ](#val-a_function) is the value below. +`` a_function`` is this type and `` a_function +`` is the value below. @@ -420,7 +419,7 @@ 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) +######   val fun_fun_fun : ((int, int) a_function, (unit, unit) a_function) a_function @@ -444,7 +443,7 @@ This is `` a_function`` with param and return type. ######   val ocaml_org : string -@see [http://ocaml.org/](http://ocaml.org/) : The OCaml Web site +@see http://ocaml.org/ : The OCaml Web site @@ -636,7 +635,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -736,7 +735,7 @@ This comment is for `` t ######                  module InnerModuleA' : sig -######                       type t = (unit, unit) [a_function](#type-a_function) +######                       type t = (unit, unit) a_function This comment is for `` t`` . @@ -830,7 +829,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -927,7 +926,7 @@ This comment is for `` t ######                  module InnerModuleA' : sig -######                       type t = (unit, unit) [a_function](#type-a_function) +######                       type t = (unit, unit) a_function This comment is for `` t`` . @@ -1027,7 +1026,7 @@ This comment is for `` t ######                  module InnerModuleA' : sig -######                       type t = (unit, unit) [a_function](#type-a_function) +######                       type t = (unit, unit) a_function This comment is for `` t`` . @@ -1127,7 +1126,7 @@ This comment is for `` t ######                  module InnerModuleA' : sig -######                       type t = (unit, unit) [a_function](#type-a_function) +######                       type t = (unit, unit) a_function This comment is for `` t`` . @@ -1420,28 +1419,28 @@ Wow! It was a polymorphic variant! ######   type (_, _) full_gadt = -######        | Tag : (unit, unit) [full_gadt](#type-full_gadt) +######        | Tag : (unit, unit) full_gadt -######        | First : 'a -> ('a, unit) [full_gadt](#type-full_gadt) +######        | First : 'a -> ('a, unit) full_gadt -######        | Second : 'a -> (unit, 'a) [full_gadt](#type-full_gadt) +######        | Second : 'a -> (unit, 'a) full_gadt -######        | Exist : 'a * 'b -> ('b, unit) [full_gadt](#type-full_gadt) +######        | Exist : 'a * 'b -> ('b, unit) full_gadt @@ -1460,21 +1459,21 @@ Wow! It was a GADT! ######   type 'a partial_gadt = -######        | AscribeTag : 'a [partial_gadt](#type-partial_gadt) +######        | AscribeTag : 'a partial_gadt -######        | OfTag of 'a [partial_gadt](#type-partial_gadt) +######        | OfTag of 'a partial_gadt -######        | ExistGadtTag : ('a -> 'b) -> 'a [partial_gadt](#type-partial_gadt) +######        | ExistGadtTag : ('a -> 'b) -> 'a partial_gadt @@ -1490,7 +1489,7 @@ Wow! It was a mixed GADT! -######   type alias = [variant](#type-variant) +######   type alias = variant This comment is for `` alias `` . @@ -1499,7 +1498,7 @@ This comment is for `` alias -######   type tuple = ([alias](#type-alias) * [alias](#type-alias)) * [alias](#type-alias) * ([alias](#type-alias) * [alias](#type-alias)) +######   type tuple = (alias * alias) * alias * (alias * alias) This comment is for `` tuple `` . @@ -1508,7 +1507,7 @@ This comment is for `` tuple -######   type variant_alias = [variant](#type-variant) = +######   type variant_alias = variant = ######        | TagA @@ -1545,7 +1544,7 @@ This comment is for `` variant_alias -######   type record_alias = [record](#type-record) = { +######   type record_alias = record = { ######        `` field1 : int; @@ -1573,8 +1572,7 @@ This comment is for `` record_alias ######   type poly_variant_union = [ -######        `` | -`` `` [poly_variant](#type-poly_variant) +######        `` | `` `` poly_variant `` @@ -1640,7 +1638,7 @@ This comment is for `` poly_variant_union -######   type 'a open_poly_variant_alias = 'a [open_poly_variant](#type-open_poly_variant) [open_poly_variant2](#type-open_poly_variant2) +######   type 'a open_poly_variant_alias = 'a open_poly_variant open_poly_variant2 @@ -1702,31 +1700,31 @@ 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 = -######        | Tag : (unit, unit) [full_gadt_alias](#type-full_gadt_alias) +######        | Tag : (unit, unit) full_gadt_alias -######        | First : 'a -> ('a, unit) [full_gadt_alias](#type-full_gadt_alias) +######        | First : 'a -> ('a, unit) full_gadt_alias -######        | Second : 'a -> (unit, 'a) [full_gadt_alias](#type-full_gadt_alias) +######        | Second : 'a -> (unit, 'a) full_gadt_alias -######        | Exist : 'a * 'b -> ('b, unit) [full_gadt_alias](#type-full_gadt_alias) +######        | Exist : 'a * 'b -> ('b, unit) full_gadt_alias @@ -1739,24 +1737,24 @@ This comment is for `` full_gadt_alias -######   type 'a partial_gadt_alias = 'a [partial_gadt](#type-partial_gadt) = +######   type 'a partial_gadt_alias = 'a partial_gadt = -######        | AscribeTag : 'a [partial_gadt_alias](#type-partial_gadt_alias) +######        | AscribeTag : 'a partial_gadt_alias -######        | OfTag of 'a [partial_gadt_alias](#type-partial_gadt_alias) +######        | OfTag of 'a partial_gadt_alias -######        | ExistGadtTag : ('a -> 'b) -> 'a [partial_gadt_alias](#type-partial_gadt_alias) +######        | ExistGadtTag : ('a -> 'b) -> 'a partial_gadt_alias @@ -1771,8 +1769,8 @@ This comment is for `` partial_gadt_alias ######   exception Exn_arrow : unit -> exn -This comment is for [`` Exn_arrow -`` ](#exception-Exn_arrow). +This comment is for `` Exn_arrow +`` . @@ -1788,19 +1786,17 @@ This comment is for [`` Exn_arrow -######        | B_ish of [mutual_constr_b](#type-mutual_constr_b) +######        | B_ish of 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`` and `` 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`` then `` mutual_constr_b +`` . @@ -1816,7 +1812,7 @@ This comment is for [`` mutual_constr_a -######        | A_ish of [mutual_constr_a](#type-mutual_constr_a) +######        | A_ish of mutual_constr_a This comment must be here for the next to associate correctly. @@ -1824,15 +1820,14 @@ This comment is for [`` mutual_constr_a -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`` then `` mutual_constr_a +`` . -######   type rec_obj = < f : int; g : unit -> unit; h : [rec_obj](#type-rec_obj); > +######   type rec_obj = < f : int; g : unit -> unit; h : rec_obj; > @@ -1870,7 +1865,7 @@ A mystery wrapped in an ellipsis -######   type [ext](#type-ext) += +######   type ext += ######        | ExtA @@ -1882,7 +1877,7 @@ A mystery wrapped in an ellipsis -######   type [ext](#type-ext) += +######   type ext += ######        | ExtB @@ -1894,7 +1889,7 @@ A mystery wrapped in an ellipsis -######   type [ext](#type-ext) += +######   type ext += ######        | ExtC of unit @@ -1904,7 +1899,7 @@ A mystery wrapped in an ellipsis -######        | ExtD of [ext](#type-ext) +######        | ExtD of ext @@ -1913,7 +1908,7 @@ A mystery wrapped in an ellipsis -######   type [ext](#type-ext) += +######   type ext += ######        | ExtE @@ -1925,7 +1920,7 @@ A mystery wrapped in an ellipsis -######   type [ext](#type-ext) += +######   type ext += ######        | ExtF @@ -1945,7 +1940,7 @@ A mystery wrapped in an ellipsis -######   type [poly_ext](#type-poly_ext) += +######   type poly_ext += ######        | Foo of 'b @@ -1966,7 +1961,7 @@ A mystery wrapped in an ellipsis -######   type [poly_ext](#type-poly_ext) += +######   type poly_ext += ######        | Quux of 'c @@ -2374,8 +2369,8 @@ With odoc, everything should be resolved (and linked) but only toplevel units wi -@[`` 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: @@ -2437,10 +2432,10 @@ I can refer to - `` {!section:indexmodules} -`` : [Trying the {!modules: ...} command.](#indexmodules) +`` : Trying the {!modules: ...} command. - `` {!aliases} -`` : [Aliases again](#aliases) +`` : Aliases again But also to things in submodules: @@ -2454,10 +2449,9 @@ But also to things in submodules: And just to make sure we do not mess up: -- `` {{!section:indexmodules}A}`` : [A](#indexmodules) +- `` {{!section:indexmodules}A}`` : A -- `` {{!aliases}B} -`` : [B](#aliases) +- `` {{!aliases}B}`` : B - `` {{!section:SuperSig.SubSigA.subSig}C}`` : C @@ -2546,7 +2540,7 @@ end -######   type [new_t](#type-new_t) += +######   type new_t += ######        | C @@ -2561,7 +2555,7 @@ end ######   module type TypeExtPruned = sig -######        type [new_t](#type-new_t) += +######        type new_t += ######             | C @@ -2573,7 +2567,7 @@ end -######        val f : [new_t](#type-new_t) -> unit +######        val f : new_t -> unit end @@ -2914,7 +2908,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -2979,7 +2973,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -3047,7 +3041,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -3087,7 +3081,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -3155,7 +3149,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -3284,7 +3278,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -3352,7 +3346,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -3392,7 +3386,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -3467,7 +3461,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -3531,7 +3525,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -3619,7 +3613,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -3687,7 +3681,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -3727,7 +3721,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -3786,7 +3780,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -3854,7 +3848,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -3894,7 +3888,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -3963,7 +3957,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -4051,7 +4045,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -4119,7 +4113,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -4159,7 +4153,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -4228,7 +4222,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -4316,7 +4310,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -4384,7 +4378,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -4424,7 +4418,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -4503,7 +4497,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -4593,7 +4587,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -4661,7 +4655,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -4701,7 +4695,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -4774,7 +4768,7 @@ This comment is for `` t ######             module InnerModuleA' : sig -######                  type t = (unit, unit) [a_function](#type-a_function) +######                  type t = (unit, unit) a_function This comment is for `` t`` . @@ -4875,7 +4869,7 @@ This comment is for `` t ######        module InnerModuleA' : sig -######             type t = (unit, unit) [a_function](#type-a_function) +######             type t = (unit, unit) a_function This comment is for `` t`` . @@ -4943,7 +4937,7 @@ This comment is for `` t ######   module InnerModuleA' : sig -######        type t = (unit, unit) [a_function](#type-a_function) +######        type t = (unit, unit) a_function This comment is for `` t`` . @@ -4983,7 +4977,7 @@ This comment is for `` InnerModuleA' `` . -######   type t = (unit, unit) [a_function](#type-a_function) +######   type t = (unit, unit) a_function This comment is for `` t `` . @@ -6642,7 +6636,7 @@ OcamlaryTypeExtPruned Module type `` Ocamlary.TypeExtPruned`` -######   type [new_t](#type-new_t) += +######   type new_t += ######        | C @@ -6654,5 +6648,5 @@ OcamlaryTypeExtPruned -######   val f : [new_t](#type-new_t) -> unit +######   val f : new_t -> unit diff --git a/test/generators/markdown/Recent.md b/test/generators/markdown/Recent.md index 309bef52fa..81d666ca5d 100644 --- a/test/generators/markdown/Recent.md +++ b/test/generators/markdown/Recent.md @@ -83,14 +83,14 @@ end ######   type _ gadt = -######        | A : int [gadt](#type-gadt) +######        | A : int gadt -######        | B : int -> string [gadt](#type-gadt) +######        | B : int -> string gadt foo @@ -107,7 +107,7 @@ end -} -> unit [gadt](#type-gadt) +} -> unit gadt @@ -170,7 +170,7 @@ end ######   type empty_conj = -######        | X : [< `X of & 'a & int * float ] -> [empty_conj](#type-empty_conj) +######        | X : [< `X of & 'a & int * float ] -> empty_conj @@ -182,7 +182,7 @@ end ######   type conj = -######        | X : [< `X of int & [< `B of int & float ] ] -> [conj](#type-conj) +######        | X : [< `X of int & [< `B of int & float ] ] -> conj diff --git a/test/generators/markdown/Type.md b/test/generators/markdown/Type.md index cc9f77664b..063b5739ae 100644 --- a/test/generators/markdown/Type.md +++ b/test/generators/markdown/Type.md @@ -70,12 +70,12 @@ Some _documentation_. -######   type instance = int [constructor](#type-constructor) +######   type instance = int constructor -######   type long = [labeled_higher_order](#type-labeled_higher_order) -> [ `Bar | `Baz of [triple](#type-triple) ] -> [pair](#type-pair) -> [labeled](#type-labeled) -> [higher_order](#type-higher_order) -> (string -> int) -> (int, float, char, string, char, unit) CamlinternalFormatBasics.fmtty -> [nested_pair](#type-nested_pair) -> [arrow](#type-arrow) -> string -> [nested_pair](#type-nested_pair) array +######   type long = labeled_higher_order -> [ `Bar | `Baz of triple ] -> pair -> labeled -> higher_order -> (string -> int) -> (int, float, char, string, char, unit) CamlinternalFormatBasics.fmtty -> nested_pair -> arrow -> string -> nested_pair array @@ -128,7 +128,7 @@ Some _documentation_. -######        | E of [variant_e](#type-variant_e) +######        | E of variant_e @@ -153,21 +153,21 @@ Some _documentation_. ######   type _ gadt = -######        | A : int [gadt](#type-gadt) +######        | A : int gadt -######        | B : int -> string [gadt](#type-gadt) +######        | B : int -> string gadt -######        | C : [variant_c](#type-variant_c) -> unit [gadt](#type-gadt) +######        | C : variant_c -> unit gadt @@ -179,7 +179,7 @@ Some _documentation_. ######   type degenerate_gadt = -######        | A : [degenerate_gadt](#type-degenerate_gadt) +######        | A : degenerate_gadt @@ -289,8 +289,7 @@ Some _documentation_. ######   type polymorphic_variant_extension = [ -######        `` | -`` `` [polymorphic_variant](#type-polymorphic_variant) +######        `` | `` `` polymorphic_variant `` @@ -329,8 +328,7 @@ Some _documentation_. ######   and private_extenion = private [> -######        `` | -`` `` [polymorphic_variant](#type-polymorphic_variant) +######        `` | `` `` polymorphic_variant `` @@ -391,7 +389,7 @@ end -######   type using_binary = (int, int) [binary](#type-binary) +######   type using_binary = (int, int) binary @@ -426,7 +424,7 @@ end -######   type 'a named_variant = 'a constraint 'a = [< [polymorphic_variant](#type-polymorphic_variant) ] +######   type 'a named_variant = 'a constraint 'a = [< polymorphic_variant ] @@ -461,13 +459,13 @@ end -######   type [extensible](#type-extensible) += +######   type extensible += ######        | Extension - Documentation for [`` Extension -`` ](#extension-Extension). + Documentation for `` Extension +`` . @@ -476,8 +474,8 @@ end ######        | Another_extension - Documentation for [`` Another_extension -`` ](#extension-Another_extension). + Documentation for `` Another_extension +`` . @@ -489,7 +487,7 @@ end ######   type mutually = -######        | A of [recursive](#type-recursive) +######        | A of recursive @@ -501,7 +499,7 @@ end ######   and recursive = -######        | B of [mutually](#type-mutually) +######        | B of mutually