-
Notifications
You must be signed in to change notification settings - Fork 426
/
Copy pathunstableSymbols.doc.good
156 lines (82 loc) · 2.06 KB
/
unstableSymbols.doc.good
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
warning in unstableSymbols.doc.chpl:2: an implicit module named 'unstableSymbols.doc' is being introduced to contain file-scope code
.. default-domain:: chpl
.. module:: unstableSymbols.doc
unstableSymbols.doc
===================
**Usage**
.. code-block:: chapel
use unstableSymbols.doc;
or
.. code-block:: chapel
import unstableSymbols.doc;
**Submodules**
.. toctree::
:maxdepth: 1
:glob:
unstableSymbols.doc/*
.. data:: var a: int
.. warning::
a is unstable
.. data:: var b: int
.. warning::
b is unstable, don't use it
.. data:: var c: string
.. warning::
c is unstable
There was documentation of this symbol
.. data:: var d: string
.. warning::
d is unstable, don't use it
This symbol was also documented
.. data:: var e: real
This symbol is unstable
.. data:: var f: real
This symbol is also unstable
.. data:: var g: bool
.. warning::
g is unstable
This symbol is not considered stable
.. data:: var h: bool
.. warning::
h is unstable, don't use it
This symbol is also not considered stable
.. default-domain:: chpl
.. module:: UnstableMod1
UnstableMod1
============
**Usage**
.. code-block:: chapel
use unstableSymbols.doc.UnstableMod1;
or
.. code-block:: chapel
import unstableSymbols.doc.UnstableMod1;
.. warning::
UnstableMod1 is unstable
.. default-domain:: chpl
.. module:: UnstableMod2
UnstableMod2
============
**Usage**
.. code-block:: chapel
use unstableSymbols.doc.UnstableMod2;
or
.. code-block:: chapel
import unstableSymbols.doc.UnstableMod2;
.. warning::
This module is unstable
.. default-domain:: chpl
.. module:: UnstableMod3
:synopsis: Including modules with documentation
UnstableMod3
============
**Usage**
.. code-block:: chapel
use unstableSymbols.doc.UnstableMod3;
or
.. code-block:: chapel
import unstableSymbols.doc.UnstableMod3;
.. warning::
This module is unstable
Including modules with documentation
.. data:: var x: int
Just a regular symbol to show how it interacts