Skip to content

Commit 6b9d840

Browse files
committed
Merge branch 'topic/update_generated_doc' into 'master'
Update the generated LKQL built-ins documentation Closes #311 See merge request eng/libadalang/langkit-query-language!274
2 parents 6fcc360 + 8e5ba07 commit 6b9d840

File tree

1 file changed

+51
-51
lines changed

1 file changed

+51
-51
lines changed

user_manual/generated/std.rst

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -77,225 +77,225 @@ Builtin methods
7777

7878
Methods for `Any`
7979
"""""""""""""""""
80-
.. method:: Any.doc(obj)
80+
.. method:: Any.doc(this)
8181

8282
Given any object, return the documentation associated with it
8383

84-
.. method:: Any.img(val)
84+
.. method:: Any.img(this)
8585

8686
Return a string representation of an object
8787

88-
.. method:: Any.print(val, new_line)
88+
.. method:: Any.print(this, new_line)
8989

9090
Built-in print function. Prints whatever is passed as an argument
9191

9292
Methods for `AnalysisUnit`
9393
""""""""""""""""""""""""""
94-
.. method:: AnalysisUnit.name(unit)
94+
.. method:: AnalysisUnit.name(this)
9595

9696
Return the name of this unit
9797

98-
.. method:: AnalysisUnit.root(unit)
98+
.. method:: AnalysisUnit.root(this)
9999

100100
Return the root for this unit
101101

102-
.. method:: AnalysisUnit.text(unit)
102+
.. method:: AnalysisUnit.text(this)
103103

104104
Return the text of the analysis unit
105105

106-
.. method:: AnalysisUnit.tokens(unit)
106+
.. method:: AnalysisUnit.tokens(this)
107107

108108
Return the tokens of the unit
109109

110110
Methods for `LazyList`
111111
""""""""""""""""""""""
112-
.. method:: LazyList.length(iterable)
112+
.. method:: LazyList.length(this)
113113

114114
Get the length of the iterable element
115115

116-
.. method:: LazyList.reduce(indexable, fn, init)
116+
.. method:: LazyList.reduce(this, fn, init)
117117

118118
Given a collection, a reduction function, and an initial value reduce the result
119119

120-
.. method:: LazyList.to_list(iterable)
120+
.. method:: LazyList.to_list(this)
121121

122122
Transform an iterator into a list
123123

124124
Methods for `List`
125125
""""""""""""""""""
126-
.. method:: List.length(iterable)
126+
.. method:: List.length(this)
127127

128128
Get the length of the iterable element
129129

130-
.. method:: List.reduce(indexable, fn, init)
130+
.. method:: List.reduce(this, fn, init)
131131

132132
Given a collection, a reduction function, and an initial value reduce the result
133133

134-
.. method:: List.sublist(list, low_bound, high_bound)
134+
.. method:: List.sublist(this, low_bound, high_bound)
135135

136136
Return a sublist of `list` from `low_bound` to `high_bound`
137137

138-
.. method:: List.to_list(iterable)
138+
.. method:: List.to_list(this)
139139

140140
Transform an iterator into a list
141141

142-
.. method:: List.unique(indexable)
142+
.. method:: List.unique(this)
143143

144144
Given collection, remove all identical elements in order to have only one instance of each
145145

146146
Methods for `Node`
147147
""""""""""""""""""
148-
.. method:: Node.children(node)
148+
.. method:: Node.children(this)
149149

150150
Given a node, get the list of all its children
151151

152-
.. method:: Node.children_count(node)
152+
.. method:: Node.children_count(this)
153153

154154
Given a node, return the count of its children
155155

156-
.. method:: Node.dump(node)
156+
.. method:: Node.dump(this)
157157

158158
Given an ast node, return a structured dump of the subtree
159159

160-
.. method:: Node.image(node)
160+
.. method:: Node.image(this)
161161

162162
Given an ast node, return its image
163163

164-
.. method:: Node.kind(node)
164+
.. method:: Node.kind(this)
165165

166166
Return the kind of this node, as a string
167167

168-
.. method:: Node.parent(node)
168+
.. method:: Node.parent(this)
169169

170170
Given a node, get the parent of it
171171

172-
.. method:: Node.same_tokens(node, other)
172+
.. method:: Node.same_tokens(this, other)
173173

174174
Return whether two nodes have the same tokens, ignoring trivias
175175

176-
.. method:: Node.text(node)
176+
.. method:: Node.text(this)
177177

178178
Given an ast node, return its text
179179

180-
.. method:: Node.tokens(node)
180+
.. method:: Node.tokens(this)
181181

182182
Given a node, return an iterator on its tokens
183183

184-
.. method:: Node.unit(node)
184+
.. method:: Node.unit(this)
185185

186186
Given an ast node, return its analysis unit
187187

188188
Methods for `SelectorList`
189189
""""""""""""""""""""""""""
190-
.. method:: SelectorList.length(iterable)
190+
.. method:: SelectorList.length(this)
191191

192192
Get the length of the iterable element
193193

194-
.. method:: SelectorList.reduce(indexable, fn, init)
194+
.. method:: SelectorList.reduce(this, fn, init)
195195

196196
Given a collection, a reduction function, and an initial value reduce the result
197197

198-
.. method:: SelectorList.to_list(iterable)
198+
.. method:: SelectorList.to_list(this)
199199

200200
Transform an iterator into a list
201201

202202
Methods for `Str`
203203
"""""""""""""""""
204-
.. method:: Str.base_name(str)
204+
.. method:: Str.base_name(this)
205205

206206
Given a string that represents a file name, returns the basename
207207

208-
.. method:: Str.contains(str, to_find)
208+
.. method:: Str.contains(this, to_find)
209209

210210
Search for to_find in the given string. Return whether a match is found. to_find can be either a pattern or a string
211211

212-
.. method:: Str.ends_with(str, suffix)
212+
.. method:: Str.ends_with(this, suffix)
213213

214214
Given a string, returns whether it ends with the given suffix
215215

216-
.. method:: Str.find(str, to_find)
216+
.. method:: Str.find(this, to_find)
217217

218218
Search for to_find in the given string. Return position of the match, or -1 if no match. to_find can be either a pattern or a string
219219

220-
.. method:: Str.is_lower_case(str)
220+
.. method:: Str.is_lower_case(this)
221221

222222
Return whether the given string contains lower case characters only
223223

224-
.. method:: Str.is_mixed_case(str)
224+
.. method:: Str.is_mixed_case(this)
225225

226226
Return whether the given string is written in mixed case, that is, with only lower case characters except the first one and every character following an underscore
227227

228-
.. method:: Str.is_upper_case(str)
228+
.. method:: Str.is_upper_case(this)
229229

230230
Return whether the given string contains upper case characters only
231231

232-
.. method:: Str.length(str)
232+
.. method:: Str.length(this)
233233

234234
Given a string, return the length of it in character
235235

236-
.. method:: Str.split(str, separator)
236+
.. method:: Str.split(this, separator)
237237

238238
Given a string, return an iterator on the words contained by str separated by separator
239239

240-
.. method:: Str.starts_with(str, prefix)
240+
.. method:: Str.starts_with(this, prefix)
241241

242242
Given a string, returns whether it starts with the given prefix
243243

244-
.. method:: Str.substring(str, from, to)
244+
.. method:: Str.substring(this, from, to)
245245

246246
Given a string and two indices (from and to), return the substring contained between indices from and to (both included)
247247

248-
.. method:: Str.to_lower_case(str)
248+
.. method:: Str.to_lower_case(this)
249249

250250
Return the given string written with lower case characters only
251251

252-
.. method:: Str.to_upper_case(str)
252+
.. method:: Str.to_upper_case(this)
253253

254254
Return the given string written with upper case characters only
255255

256256
Methods for `Token`
257257
"""""""""""""""""""
258-
.. method:: Token.end_column(token)
258+
.. method:: Token.end_column(this)
259259

260260
Return the column end
261261

262-
.. method:: Token.end_line(token)
262+
.. method:: Token.end_line(this)
263263

264264
Return the line end
265265

266266
.. method:: Token.is_equivalent(this, other)
267267

268268
Return whether two tokens are structurally equivalent
269269

270-
.. method:: Token.is_trivia(token)
270+
.. method:: Token.is_trivia(this)
271271

272272
Return whether this token is a trivia
273273

274-
.. method:: Token.kind(token)
274+
.. method:: Token.kind(this)
275275

276276
Return the kind of the token
277277

278-
.. method:: Token.next(token, exclude_trivia)
278+
.. method:: Token.next(this, exclude_trivia)
279279

280280
Return the next token
281281

282-
.. method:: Token.previous(token, exclude_trivia)
282+
.. method:: Token.previous(this, exclude_trivia)
283283

284284
Return the previous token
285285

286-
.. method:: Token.start_column(token)
286+
.. method:: Token.start_column(this)
287287

288288
Return the column start
289289

290-
.. method:: Token.start_line(token)
290+
.. method:: Token.start_line(this)
291291

292292
Return the line start
293293

294-
.. method:: Token.text(token)
294+
.. method:: Token.text(this)
295295

296296
Return the text of the token
297297

298-
.. method:: Token.unit(token)
298+
.. method:: Token.unit(this)
299299

300300
Return the unit for this token
301301

0 commit comments

Comments
 (0)