Skip to content

Commit b0cc543

Browse files
committed
Promote tests, don't generate links in markdown by default
Signed-off-by: lubegasimon <[email protected]>
1 parent 2584bfc commit b0cc543

15 files changed

+176
-186
lines changed

test/generators/markdown/Bugs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Bugs
99
<a id="val-foo"></a>
1010
###### &nbsp; val foo : ?bar:'a -> unit -> unit
1111

12-
Triggers an assertion failure when [https://github.com/ocaml/odoc/issues/101](https://github.com/ocaml/odoc/issues/101) is not fixed.
12+
Triggers an assertion failure when https://github.com/ocaml/odoc/issues/101 is not fixed.
1313

1414

test/generators/markdown/Include.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ end
6666
###### &nbsp; module type Inherent_Module = sig
6767

6868
<a id="val-a"></a>
69-
###### &nbsp; &nbsp; &nbsp; &nbsp;val a : [t](#type-t)
69+
###### &nbsp; &nbsp; &nbsp; &nbsp;val a : t
7070

7171

7272
end
@@ -81,7 +81,7 @@ end
8181

8282

8383
<a id="val-a"></a>
84-
###### &nbsp; &nbsp; &nbsp; &nbsp;val a : [u](#type-u)
84+
###### &nbsp; &nbsp; &nbsp; &nbsp;val a : u
8585

8686

8787
end
@@ -91,7 +91,7 @@ end
9191

9292

9393
<a id="val-a"></a>
94-
###### &nbsp; val a : [u](#type-u)
94+
###### &nbsp; val a : u
9595

9696

9797
IncludeNot_inlined
@@ -126,7 +126,7 @@ IncludeInherent_Module
126126

127127
Module type `` Include.Inherent_Module``
128128
<a id="val-a"></a>
129-
###### &nbsp; val a : [t](#type-t)
129+
###### &nbsp; val a : t
130130

131131

132132
IncludeDorminant_Module
@@ -135,5 +135,5 @@ IncludeDorminant_Module
135135

136136

137137
<a id="val-a"></a>
138-
###### &nbsp; val a : [u](#type-u)
138+
###### &nbsp; val a : u
139139

test/generators/markdown/Labels.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ Attached to type
2323

2424

2525
<a id="val-f"></a>
26-
###### &nbsp; val f : [t](#type-t)
26+
###### &nbsp; val f : t
2727

2828
Attached to value
2929

3030

3131

3232

3333
<a id="val-e"></a>
34-
###### &nbsp; val e : unit -> [t](#type-t)
34+
###### &nbsp; val e : unit -> t
3535

3636
Attached to external
3737

@@ -77,7 +77,7 @@ Attached to exception
7777

7878

7979
<a id="extension-decl-X"></a>
80-
###### &nbsp; type [x](#type-x) +=
80+
###### &nbsp; type x +=
8181

8282
<a id="extension-X"></a>
8383
###### &nbsp; &nbsp; &nbsp; &nbsp;| X
@@ -100,7 +100,7 @@ Attached to module subst
100100

101101

102102
<a id="type-s"></a>
103-
###### &nbsp; type s := [t](#type-t)
103+
###### &nbsp; type s := t
104104

105105
Attached to type subst
106106

@@ -125,7 +125,7 @@ Attached to type subst
125125
###### &nbsp; type v = {
126126

127127
<a id="type-v.f"></a>
128-
###### &nbsp; &nbsp; &nbsp; &nbsp;`` f : [t](#type-t);
128+
###### &nbsp; &nbsp; &nbsp; &nbsp;`` f : t;
129129
``
130130

131131
Attached to field
@@ -139,31 +139,31 @@ Attached to type subst
139139
Testing that labels can be referenced
140140

141141

142-
- [Attached to unit](#L1)
142+
- Attached to unit
143143

144-
- [Attached to nothing](#L2)
144+
- Attached to nothing
145145

146-
- [Attached to module](#L3)
146+
- Attached to module
147147

148-
- [Attached to type](#L4)
148+
- Attached to type
149149

150-
- [Attached to value](#L5)
150+
- Attached to value
151151

152-
- [Attached to class](#L6)
152+
- Attached to class
153153

154-
- [Attached to class type](#L7)
154+
- Attached to class type
155155

156-
- [Attached to exception](#L8)
156+
- Attached to exception
157157

158-
- [Attached to extension](#L9)
158+
- Attached to extension
159159

160-
- [Attached to module subst](#L10)
160+
- Attached to module subst
161161

162-
- [Attached to type subst](#L11)
162+
- Attached to type subst
163163

164-
- [Attached to constructor](#L12)
164+
- Attached to constructor
165165

166-
- [Attached to field](#L13)
166+
- Attached to field
167167

168168
LabelsA
169169

test/generators/markdown/Markup.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ but odoc has banned deeper headings. There are also title headings, but they are
3636
### Anchors
3737

3838

39-
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.
39+
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.
4040

4141

4242

@@ -67,8 +67,7 @@ _emphasis_, __emphasis_ within emphasis_, **_bold italic_**, super<sup>script, s
6767

6868
Note: _In italics _emphasis_ is rendered as normal text while _emphasis
6969
_in_ emphasis_ is rendered in italics._
70-
_It also work the same in [links](#)[ ](#)[in](#)[ ](#)[italics](#)[ ](#)
71-
[with](#)[ ](#)[.](#)_
70+
_It also work the same in links in italics with _emphasis _in_ emphasis_._
7271

7372

7473
`` code
@@ -92,17 +91,17 @@ Code can appear **inside `` other`` markup**. Its display shouldn't be affected
9291
# Links and references
9392

9493

95-
This is a [link](#). It sends you to the top of this page. Links can have markup inside them: , , ,
96-
[super](#), [sub](#), and . Links can also be nested _[inside](#)_ markup. Links cannot be nested inside each other. This link has no replacement text:
97-
[#](#). The text is filled in by odoc. This is a shorthand link: [#](#). The text is also filled in by odoc in this case.
94+
This is a link. It sends you to the top of this page. Links can have markup inside them:
95+
**bold**, _italics_, _emphasis_, super<sup>script, sub<sub>script, and
96+
`` code
97+
`` . 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.
9898

9999

100-
This is a reference to [`` foo
101-
`` ](#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: [
102-
**bold**](#val-foo), [_italic_](#val-foo), [_emphasis_](#val-foo), [super
103-
<sup>script](#val-foo), [sub<sub>script](#val-foo), and [`` code
104-
`` ](#val-foo). It's also possible to surround a reference in a style:
105-
**[`` foo`` ](#val-foo)**. References can't be nested inside references, and links and references can't be nested inside each other.
100+
This is a reference to `` foo
101+
`` . 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:
102+
**bold**, _italic_, _emphasis_, super<sup>script, sub<sub>script, and
103+
`` code
104+
`` . 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.
106105

107106

108107

@@ -165,8 +164,8 @@ can use explicitly-delimited lists.
165164

166165
- and can include references
167166

168-
- [`` foo
169-
`` ](#val-foo)
167+
- `` foo
168+
``
170169

171170

172171

@@ -245,7 +244,7 @@ Each comment can end with zero or more tags. Here are some examples:
245244

246245

247246

248-
@see [#](#) : this url
247+
@see # : this url
249248

250249

251250

test/generators/markdown/Module.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Foo.
88
<a id="val-foo"></a>
99
###### &nbsp; val foo : unit
1010

11-
The module needs at least one signature item, otherwise a bug causes the compiler to drop the module comment (above). See
12-
[https://caml.inria.fr/mantis/view.php?id=7701](https://caml.inria.fr/mantis/view.php?id=7701).
11+
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.
1312

1413

1514

test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This comment is for `` InnerModuleA'
77
`` .
88

99
<a id="type-t"></a>
10-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
10+
###### &nbsp; type t = (unit, unit) a_function
1111

1212
This comment is for `` t
1313
`` .

test/generators/markdown/Ocamlary.CollectionModule.InnerModuleA.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This comment is for `` InnerModuleA'
5050
`` .
5151

5252
<a id="type-t"></a>
53-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
53+
###### &nbsp; type t = (unit, unit) a_function
5454

5555
This comment is for `` t
5656
`` .

test/generators/markdown/Ocamlary.CollectionModule.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ This comment is for `` InnerModuleA'
8989
`` .
9090

9191
<a id="type-t"></a>
92-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
92+
###### &nbsp; type t = (unit, unit) a_function
9393

9494
This comment is for `` t
9595
`` .

test/generators/markdown/Ocamlary.FunctorTypeOf.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This comment is for `` t
4848
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;module InnerModuleA' : sig
4949

5050
<a id="type-t"></a>
51-
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
51+
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
5252

5353
This comment is for `` t`` .
5454

@@ -149,7 +149,7 @@ This comment is for `` t
149149
###### &nbsp; &nbsp; &nbsp; &nbsp;module InnerModuleA' : sig
150150

151151
<a id="type-t"></a>
152-
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
152+
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
153153

154154
This comment is for `` t`` .
155155

@@ -217,7 +217,7 @@ This comment is for `` t
217217
###### &nbsp; module InnerModuleA' : sig
218218

219219
<a id="type-t"></a>
220-
###### &nbsp; &nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
220+
###### &nbsp; &nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
221221

222222
This comment is for `` t`` .
223223

@@ -257,7 +257,7 @@ This comment is for `` InnerModuleA'
257257
`` .
258258

259259
<a id="type-t"></a>
260-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
260+
###### &nbsp; type t = (unit, unit) a_function
261261

262262
This comment is for `` t
263263
`` .

test/generators/markdown/Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This comment is for `` InnerModuleA'
77
`` .
88

99
<a id="type-t"></a>
10-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
10+
###### &nbsp; type t = (unit, unit) a_function
1111

1212
This comment is for `` t
1313
`` .

test/generators/markdown/Ocamlary.Recollection.InnerModuleA.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This comment is for `` InnerModuleA'
5050
`` .
5151

5252
<a id="type-t"></a>
53-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
53+
###### &nbsp; type t = (unit, unit) a_function
5454

5555
This comment is for `` t
5656
`` .

test/generators/markdown/Ocamlary.Recollection.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This comment is for `` t
4343
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;module InnerModuleA' : sig
4444

4545
<a id="type-t"></a>
46-
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
46+
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
4747

4848
This comment is for `` t`` .
4949

@@ -172,7 +172,7 @@ This comment is for `` t
172172
###### &nbsp; &nbsp; &nbsp; &nbsp;module InnerModuleA' : sig
173173

174174
<a id="type-t"></a>
175-
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
175+
###### &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
176176

177177
This comment is for `` t`` .
178178

@@ -240,7 +240,7 @@ This comment is for `` t
240240
###### &nbsp; module InnerModuleA' : sig
241241

242242
<a id="type-t"></a>
243-
###### &nbsp; &nbsp; &nbsp; &nbsp;type t = (unit, unit) [a_function](#type-a_function)
243+
###### &nbsp; &nbsp; &nbsp; &nbsp;type t = (unit, unit) a_function
244244

245245
This comment is for `` t`` .
246246

@@ -280,7 +280,7 @@ This comment is for `` InnerModuleA'
280280
`` .
281281

282282
<a id="type-t"></a>
283-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
283+
###### &nbsp; type t = (unit, unit) a_function
284284

285285
This comment is for `` t
286286
`` .
@@ -355,7 +355,7 @@ This comment is for `` InnerModuleA'
355355
`` .
356356

357357
<a id="type-t"></a>
358-
###### &nbsp; type t = (unit, unit) [a_function](#type-a_function)
358+
###### &nbsp; type t = (unit, unit) a_function
359359

360360
This comment is for `` t
361361
`` .

0 commit comments

Comments
 (0)