Skip to content

Commit 4f9a548

Browse files
committed
promote tests
1 parent 7d0c982 commit 4f9a548

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+281
-142
lines changed

test/generators/markdown/Alias.X.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Module `Alias.X`
1010

1111
> int
1212
13-
Module Foo__X documentation. This should appear in the documentation for the alias to this module 'X'
13+
Module Foo__X documentation. This should appear in the documentation for the
14+
alias to this module 'X'

test/generators/markdown/Bugs.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ Module `Bugs`
1414

1515
> ?bar:'a -> unit -> unit
1616
17-
Triggers an assertion failure when [https://github.com/ocaml/odoc/issues/101](https://github.com/ocaml/odoc/issues/101) is not fixed.
17+
Triggers an assertion failure when
18+
[https://github.com/ocaml/odoc/issues/101](https://github.com/ocaml/odoc/issues/101)
19+
is not fixed.

test/generators/markdown/Bugs_post_406.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Bugs_post_406
22

33
Module `Bugs_post_406`
44

5-
Let-open in class types, https://github.com/ocaml/odoc/issues/543 This was added to the language in 4.06
5+
Let-open in class types, https://github.com/ocaml/odoc/issues/543 This was
6+
added to the language in 4.06
67

78
<a id="class-type-let_open"></a>
89

test/generators/markdown/Include.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ Module `Include`
2020

2121
<a id="module-type-Not_inlined_and_closed"></a>
2222

23-
###### module type [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md)
23+
###### module type
24+
[Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md)
2425

25-
include [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md)
26+
include
27+
[Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md)
2628

2729
<a id="module-type-Not_inlined_and_opened"></a>
2830

29-
###### module type [Not_inlined_and_opened](Include.module-type-Not_inlined_and_opened.md)
31+
###### module type
32+
[Not_inlined_and_opened](Include.module-type-Not_inlined_and_opened.md)
3033

3134
<a id="type-w"></a>
3235

@@ -38,7 +41,8 @@ include [Not_inlined_and_closed](Include.module-type-Not_inlined_and_closed.md)
3841

3942
<a id="module-type-Dorminant_Module"></a>
4043

41-
###### module type [Dorminant_Module](Include.module-type-Dorminant_Module.md)
44+
###### module type
45+
[Dorminant_Module](Include.module-type-Dorminant_Module.md)
4246

4347
<a id="val-a"></a>
4448

test/generators/markdown/Include2.Y_include_synopsis.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Y_include_synopsis
44

55
Module `Include2.Y_include_synopsis`
66

7-
The `include Y` below should have the synopsis from `Y`'s top-comment attached to it.
7+
The `include Y` below should have the synopsis from `Y`'s top-comment
8+
attached to it.
89

910
<a id="type-t"></a>
1011

test/generators/markdown/Include2.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Top-comment of Y.
2626

2727
###### module [Y_include_synopsis](Include2.Y_include_synopsis.md)
2828

29-
The `include Y` below should have the synopsis from `Y`'s top-comment attached to it.
29+
The `include Y` below should have the synopsis from `Y`'s top-comment
30+
attached to it.
3031

3132
<a id="module-Y_include_doc"></a>
3233

test/generators/markdown/Include_sections.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Some text.
2222

2323
# Second include
2424

25-
Let's include [`Something`](Include_sections.module-type-Something.md) a second time: the heading level should be shift here.
25+
Let's include [`Something`](Include_sections.module-type-Something.md) a
26+
second time: the heading level should be shift here.
2627

2728
# Something 1
2829

@@ -48,7 +49,8 @@ foo
4849

4950
Some text.
5051

51-
And let's include it again, but without inlining it this time: the ToC shouldn't grow.
52+
And let's include it again, but without inlining it this time: the ToC
53+
shouldn't grow.
5254

5355
<a id="val-something"></a>
5456

test/generators/markdown/Labels.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Attached to constructor
9494

9595
<a id="type-v"></a>
9696

97-
###### type v = {
97+
###### type v =
9898

9999
<a id="type-v.f"></a>
100100

test/generators/markdown/Markup.md

+41-12
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Here, we test the rendering of comment markup.
66

77
# Sections
88

9-
Let's get these done first, because sections will be used to break up the rest of this test.
9+
Let's get these done first, because sections will be used to break up the
10+
rest of this test.
1011

1112
Besides the section heading above, there are also
1213

@@ -16,39 +17,65 @@ and
1617

1718
### Sub-subsection headings
1819

19-
but odoc has banned deeper headings. There are also title headings, but they are only allowed in mld files.
20+
but odoc has banned deeper headings. There are also title headings, but they
21+
are only allowed in mld files.
2022

2123
### Anchors
2224

23-
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.
25+
Sections can have attached [Anchors](#anchors), and it is possible to
26+
[link](#anchors) to them. Links to section headers should not be set in
27+
source code style.
2428

2529
#### Paragraph
2630

2731
Individual paragraphs can have a heading.
2832

2933
##### Subparagraph
3034

31-
Parts of a longer paragraph that can be considered alone can also have headings.
35+
Parts of a longer paragraph that can be considered alone can also have
36+
headings.
3237

3338
# Styling
3439

35-
This paragraph has some styled elements: **bold** and _italic_, **_bold italic_**, _emphasis_, __emphasis_ within emphasis_, **_bold italic_**, super<sup>script</sup>, sub<sub>script</sub>. The line spacing should be enough for superscripts and subscripts not to look odd.
40+
This paragraph has some styled elements: **bold** and _italic_, **_bold
41+
italic_**, _emphasis_, __emphasis_ within emphasis_, **_bold italic_**,
42+
super<sup>script</sup>, sub<sub>script</sub>. The line spacing should be
43+
enough for superscripts and subscripts not to look odd.
3644

37-
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_.](#)_
45+
Note: _In italics _emphasis_ is rendered as normal text while _emphasis _in_
46+
emphasis_ is rendered in italics._ _It also work the same in [links in
47+
italics with _emphasis _in_ emphasis_.](#)_
3848

3949
`code` is a different kind of markup that doesn't allow nested markup.
4050

41-
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_.
51+
It's possible for two markup elements to appear **next** _to_ each other and
52+
have a space, and appear **next**_to_ each other with no space. It doesn't
53+
matter **how** _much_ space it was in the source: in this sentence, it was
54+
two space characters. And in this one, there is **a** _newline_.
4255

4356
This is also true between _non-_`code` markup _and_ `code`.
4457

4558
Code can appear **inside `other` markup**. Its display shouldn't be affected.
4659

4760
# Links and references
4861

49-
This is a [link](#). It sends you to the top of this page. Links can have markup inside them: [**bold**](#), [_italics_](#), [_emphasis_](#), [super<sup>script</sup>](#), [sub<sub>script</sub>](#), 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.
50-
51-
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<sup>script</sup>](#val-foo), [sub<sub>script</sub>](#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.
62+
This is a [link](#). It sends you to the top of this page. Links can have
63+
markup inside them: [**bold**](#), [_italics_](#), [_emphasis_](#),
64+
[super<sup>script</sup>](#), [sub<sub>script</sub>](#), and [`code`](#).
65+
Links can also be nested _[inside](#)_ markup. Links cannot be nested inside
66+
each other. This link has no replacement text: [#](#). The text is filled in
67+
by odoc. This is a shorthand link: [#](#). The text is also filled in by odoc
68+
in this case.
69+
70+
This is a reference to [`foo`](#val-foo). References can have replacement
71+
text: [the value foo](#val-foo). Except for the special lookup support,
72+
references are pretty much just like links. The replacement text can have
73+
nested styles: [**bold**](#val-foo), [_italic_](#val-foo),
74+
[_emphasis_](#val-foo), [super<sup>script</sup>](#val-foo),
75+
[sub<sub>script</sub>](#val-foo), and [`code`](#val-foo). It's also possible
76+
to surround a reference in a style: **[`foo`](#val-foo)**. References can't
77+
be nested inside references, and links and references can't be nested inside
78+
each other.
5279

5380
# Preformatted text
5481

@@ -85,7 +112,8 @@ The main difference is these don't get syntax highlighting.
85112
2. shorthand numbered list.
86113

87114

88-
- Shorthand list items can span multiple lines, however trying to put two paragraphs into a shorthand list item using a double line break
115+
- Shorthand list items can span multiple lines, however trying to put two
116+
paragraphs into a shorthand list item using a double line break
89117

90118

91119
just creates a paragraph outside the list.
@@ -126,7 +154,8 @@ The parser supports any ASCII-compatible encoding, in particuλar UTF-8.
126154

127155
# Raw HTML
128156

129-
Raw HTML can be <input type="text" placeholder="inserted"> as inline elements into sentences.
157+
Raw HTML can be <input type="text" placeholder="inserted"> as inline elements
158+
into sentences.
130159

131160

132161
<blockquote>

test/generators/markdown/Module.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Foo.
1010

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

1517
<a id="module-type-S"></a>
1618

test/generators/markdown/Nested.F.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Some additional comments.
2626

2727
###### type t =
2828

29-
> [Arg1.t](Nested.F.argument-1-Arg1.md#type-t) * [Arg2.t](Nested.F.argument-2-Arg2.md#type-t)
29+
> [Arg1.t](Nested.F.argument-1-Arg1.md#type-t)
30+
> * [Arg2.t](Nested.F.argument-2-Arg2.md#type-t)
3031
3132
Some type.

test/generators/markdown/Ocamlary.Aliases.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ Let's imitate jst's layout.
5656
5757
### include of Foo
5858

59-
Just for giggle, let's see what happens when we include [`Foo`](Ocamlary.Aliases.Foo.md).
59+
Just for giggle, let's see what happens when we include
60+
[`Foo`](Ocamlary.Aliases.Foo.md).
6061

6162
<a id="module-A"></a>
6263

@@ -92,7 +93,8 @@ Just for giggle, let's see what happens when we include [`Foo`](Ocamlary.Aliases
9293

9394
> [A.t](Ocamlary.Aliases.Foo.A.md#type-t)
9495
95-
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)
96+
And also, let's refer to [`A.t`](Ocamlary.Aliases.Foo.A.md#type-t) and
97+
[`Foo.B.id`](Ocamlary.Aliases.Foo.B.md#val-id)
9698

9799
<a id="module-P1"></a>
98100

test/generators/markdown/Ocamlary.CanonicalTest.Base_Tests.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ Module `CanonicalTest.Base_Tests`
2020

2121
###### val foo :
2222

23-
> int [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> float [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t)
23+
> int [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> float
24+
> [L.t](Ocamlary.CanonicalTest.Base.List.md#type-t)
2425
2526
<a id="val-bar"></a>
2627

2728
###### val bar :
2829

29-
> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t)
30+
> 'a [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t) -> 'a
31+
> [Base.List.t](Ocamlary.CanonicalTest.Base.List.md#type-t)
3032
3133
<a id="val-baz"></a>
3234

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ This comment is for `t`.
1818

1919
<a id="module-InnerModuleA'"></a>
2020

21-
###### module [InnerModuleA'](Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md)
21+
###### module
22+
[InnerModuleA'](Ocamlary.CollectionModule.InnerModuleA.InnerModuleA'.md)
2223

2324
This comment is for `InnerModuleA'`.
2425

2526
<a id="module-type-InnerModuleTypeA'"></a>
2627

27-
###### module type [InnerModuleTypeA'](Ocamlary.CollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md)
28+
###### module type
29+
[InnerModuleTypeA'](Ocamlary.CollectionModule.InnerModuleA.module-type-InnerModuleTypeA'.md)
2830

2931
This comment is for `InnerModuleTypeA'`.

test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ This comment is for `t`.
2020

2121
<a id="module-InnerModuleA'"></a>
2222

23-
###### module [InnerModuleA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.InnerModuleA'.md)
23+
###### module
24+
[InnerModuleA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.InnerModuleA'.md)
2425

2526
This comment is for `InnerModuleA'`.
2627

2728
<a id="module-type-InnerModuleTypeA'"></a>
2829

29-
###### module type [InnerModuleTypeA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.module-type-InnerModuleTypeA'.md)
30+
###### module type
31+
[InnerModuleTypeA'](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.module-type-InnerModuleTypeA'.md)
3032

3133
This comment is for `InnerModuleTypeA'`.

test/generators/markdown/Ocamlary.FunctorTypeOf.argument-1-Collection.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ This comment is for `collection`.
2020

2121
<a id="module-InnerModuleA"></a>
2222

23-
###### module [InnerModuleA](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md)
23+
###### module
24+
[InnerModuleA](Ocamlary.FunctorTypeOf.argument-1-Collection.InnerModuleA.md)
2425

2526
This comment is for `InnerModuleA`.
2627

test/generators/markdown/Ocamlary.IncludeInclude1.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ Module `Ocamlary.IncludeInclude1`
66

77
<a id="module-type-IncludeInclude2"></a>
88

9-
###### module type [IncludeInclude2](Ocamlary.IncludeInclude1.module-type-IncludeInclude2.md)
9+
###### module type
10+
[IncludeInclude2](Ocamlary.IncludeInclude1.module-type-IncludeInclude2.md)
1011

1112
<a id="module-IncludeInclude2_M"></a>
1213

13-
###### module [IncludeInclude2_M](Ocamlary.IncludeInclude1.IncludeInclude2_M.md)
14+
###### module
15+
[IncludeInclude2_M](Ocamlary.IncludeInclude1.IncludeInclude2_M.md)

test/generators/markdown/Ocamlary.ModuleWithSignature.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ ModuleWithSignature
44

55
Module `Ocamlary.ModuleWithSignature`
66

7-
A plain module of a signature of [`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference)
7+
A plain module of a signature of
8+
[`EmptySig`](Ocamlary.module-type-EmptySig.md) (reference)

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ This comment is for `t`.
1818

1919
<a id="module-InnerModuleA'"></a>
2020

21-
###### module [InnerModuleA'](Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md)
21+
###### module
22+
[InnerModuleA'](Ocamlary.Recollection.InnerModuleA.InnerModuleA'.md)
2223

2324
This comment is for `InnerModuleA'`.
2425

2526
<a id="module-type-InnerModuleTypeA'"></a>
2627

27-
###### module type [InnerModuleTypeA'](Ocamlary.Recollection.InnerModuleA.module-type-InnerModuleTypeA'.md)
28+
###### module type
29+
[InnerModuleTypeA'](Ocamlary.Recollection.InnerModuleA.module-type-InnerModuleTypeA'.md)
2830

2931
This comment is for `InnerModuleTypeA'`.

test/generators/markdown/Ocamlary.Recollection.argument-1-C.InnerModuleA.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ This comment is for `t`.
2020

2121
<a id="module-InnerModuleA'"></a>
2222

23-
###### module [InnerModuleA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.InnerModuleA'.md)
23+
###### module
24+
[InnerModuleA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.InnerModuleA'.md)
2425

2526
This comment is for `InnerModuleA'`.
2627

2728
<a id="module-type-InnerModuleTypeA'"></a>
2829

29-
###### module type [InnerModuleTypeA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.module-type-InnerModuleTypeA'.md)
30+
###### module type
31+
[InnerModuleTypeA'](Ocamlary.Recollection.argument-1-C.InnerModuleA.module-type-InnerModuleTypeA'.md)
3032

3133
This comment is for `InnerModuleTypeA'`.

test/generators/markdown/Ocamlary.Recollection.argument-1-C.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ This comment is for `collection`.
2020

2121
<a id="module-InnerModuleA"></a>
2222

23-
###### module [InnerModuleA](Ocamlary.Recollection.argument-1-C.InnerModuleA.md)
23+
###### module
24+
[InnerModuleA](Ocamlary.Recollection.argument-1-C.InnerModuleA.md)
2425

2526
This comment is for `InnerModuleA`.
2627

0 commit comments

Comments
 (0)