Skip to content

Commit a0b5461

Browse files
actions-useractions-user
committed
[skip ci] doc: update generated wiki pages (wiki/Interface,wiki/Core,wiki/Linter,README,bug-report.yaml)
1 parent 749f8ca commit a0b5461

14 files changed

+126
-126
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ body:
3131
options:
3232
# START::Versions
3333
- <Older> (please consider updating)
34-
- v2.2.13 (May 27, 2025)
3534
- v2.2.14 (May 31, 2025)
3635
- v2.2.15 (Jun 2, 2025)
3736
- v2.2.16 (Jul 12, 2025)
3837
- v2.3.0 (Jul 21, 2025)
3938
- v2.4.0 (Aug 6, 2025)
4039
- v2.4.1 (Aug 18, 2025)
4140
- v2.4.2 (Aug 19, 2025)
41+
- v2.4.3 (Aug 20, 2025)
4242
- Unknown
4343
- Unreleased/Dev
4444
# END::Versions

‎README.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ It offers a wide variety of features, for example:
2424

2525
```shell
2626
$ docker run -it --rm eagleoutice/flowr # or npm run flowr
27-
flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
27+
flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
2828
R> :query @linter "read.csv(\"/root/x.txt\")"
2929
```
3030

@@ -39,24 +39,24 @@ It offers a wide variety of features, for example:
3939
╰ **File Path Validity** (file-path-validity):
4040
╰ certain:
4141
╰ Path `/root/x.txt` at 1.1-23
42-
╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":0,"processTimeMs":1}</code>
42+
╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":1,"processTimeMs":0}</code>
4343
╰ **Seeded Randomness** (seeded-randomness):
4444
╰ _Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":0}</code>
4545
╰ **Absolute Paths** (absolute-file-paths):
4646
╰ certain:
4747
╰ Path `/root/x.txt` at 1.1-23
48-
╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":0,"processTimeMs":0}</code>
48+
╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":0}</code>
4949
╰ **Unused Definitions** (unused-definitions):
5050
╰ _Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":0}</code>
5151
╰ **Naming Convention** (naming-convention):
5252
╰ _Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":0}</code>
5353
╰ **Dataframe Access Validation** (dataframe-access-validation):
54-
╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":1}</code>
54+
╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":0}</code>
5555
╰ **Dead Code** (dead-code):
5656
╰ _Metadata_: <code>{"consideredNodes":5,"searchTimeMs":0,"processTimeMs":0}</code>
5757
╰ **Useless Loops** (useless-loop):
5858
╰ _Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":0}</code>
59-
[;3mAll queries together required ≈2 ms (1ms accuracy, total 8 ms)[0m[0m
59+
[;3mAll queries together required ≈2 ms (1ms accuracy, total 7 ms)[0m[0m
6060
```
6161
6262
@@ -80,32 +80,32 @@ It offers a wide variety of features, for example:
8080
8181
Query: **linter** (14 ms)\
8282
&nbsp;&nbsp;&nbsp;╰ **Deprecated Functions** (deprecated-functions):\
83-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalDeprecatedCalls":0,"totalDeprecatedFunctionDefinitions":0,"searchTimeMs":2,"processTimeMs":0}</code>\
83+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalDeprecatedCalls":0,"totalDeprecatedFunctionDefinitions":0,"searchTimeMs":1,"processTimeMs":0}</code>\
8484
&nbsp;&nbsp;&nbsp;╰ **File Path Validity** (file-path-validity):\
8585
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
8686
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `/root/x.txt` at 1.1-23\
87-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":4,"processTimeMs":1}</code>\
87+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":5,"processTimeMs":0}</code>\
8888
&nbsp;&nbsp;&nbsp;╰ **Seeded Randomness** (seeded-randomness):\
89-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":1}</code>\
89+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":1,"processTimeMs":0}</code>\
9090
&nbsp;&nbsp;&nbsp;╰ **Absolute Paths** (absolute-file-paths):\
9191
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
9292
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `/root/x.txt` at 1.1-23\
93-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":2,"processTimeMs":0}</code>\
93+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":1}</code>\
9494
&nbsp;&nbsp;&nbsp;╰ **Unused Definitions** (unused-definitions):\
9595
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":0}</code>\
9696
&nbsp;&nbsp;&nbsp;╰ **Naming Convention** (naming-convention):\
9797
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":0}</code>\
9898
&nbsp;&nbsp;&nbsp;╰ **Dataframe Access Validation** (dataframe-access-validation):\
9999
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":3}</code>\
100100
&nbsp;&nbsp;&nbsp;╰ **Dead Code** (dead-code):\
101-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"consideredNodes":5,"searchTimeMs":1,"processTimeMs":0}</code>\
101+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"consideredNodes":5,"searchTimeMs":0,"processTimeMs":0}</code>\
102102
&nbsp;&nbsp;&nbsp;╰ **Useless Loops** (useless-loop):\
103-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":0}</code>\
104-
_All queries together required ≈14 ms (1ms accuracy, total 209 ms)_
103+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":1,"processTimeMs":0}</code>\
104+
_All queries together required ≈14 ms (1ms accuracy, total 208 ms)_
105105
106106
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
107107
108-
The analysis required _208.5 ms_ (including parsing and normalization and the query) within the generation environment.
108+
The analysis required _208.4 ms_ (including parsing and normalization and the query) within the generation environment.
109109
110110
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
111111
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -122,7 +122,7 @@ It offers a wide variety of features, for example:
122122
".meta": {
123123
"totalDeprecatedCalls": 0,
124124
"totalDeprecatedFunctionDefinitions": 0,
125-
"searchTimeMs": 2,
125+
"searchTimeMs": 1,
126126
"processTimeMs": 0
127127
}
128128
},
@@ -144,8 +144,8 @@ It offers a wide variety of features, for example:
144144
"totalUnknown": 0,
145145
"totalWritesBeforeAlways": 0,
146146
"totalValid": 0,
147-
"searchTimeMs": 4,
148-
"processTimeMs": 1
147+
"searchTimeMs": 5,
148+
"processTimeMs": 0
149149
}
150150
},
151151
"seeded-randomness": {
@@ -155,8 +155,8 @@ It offers a wide variety of features, for example:
155155
"callsWithFunctionProducers": 0,
156156
"callsWithAssignmentProducers": 0,
157157
"callsWithNonConstantProducers": 0,
158-
"searchTimeMs": 0,
159-
"processTimeMs": 1
158+
"searchTimeMs": 1,
159+
"processTimeMs": 0
160160
}
161161
},
162162
"absolute-file-paths": {
@@ -175,8 +175,8 @@ It offers a wide variety of features, for example:
175175
".meta": {
176176
"totalConsidered": 1,
177177
"totalUnknown": 0,
178-
"searchTimeMs": 2,
179-
"processTimeMs": 0
178+
"searchTimeMs": 1,
179+
"processTimeMs": 1
180180
}
181181
},
182182
"unused-definitions": {
@@ -210,15 +210,15 @@ It offers a wide variety of features, for example:
210210
"results": [],
211211
".meta": {
212212
"consideredNodes": 5,
213-
"searchTimeMs": 1,
213+
"searchTimeMs": 0,
214214
"processTimeMs": 0
215215
}
216216
},
217217
"useless-loop": {
218218
"results": [],
219219
".meta": {
220220
"numOfUselessLoops": 0,
221-
"searchTimeMs": 0,
221+
"searchTimeMs": 1,
222222
"processTimeMs": 0
223223
}
224224
}
@@ -295,7 +295,7 @@ It offers a wide variety of features, for example:
295295
296296
```shell
297297
$ docker run -it --rm eagleoutice/flowr # or npm run flowr
298-
flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
298+
flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
299299
R> :slicer test/testfiles/example.R --criterion "11@sum"
300300
```
301301
@@ -342,7 +342,7 @@ It offers a wide variety of features, for example:
342342
343343
344344
* 🚀 **fast data- and control-flow graphs**\
345-
Within just <i><span title="This measurement is automatically fetched from the latest benchmark!">132.8 ms</span></i> (as of Aug 19, 2025),
345+
Within just <i><span title="This measurement is automatically fetched from the latest benchmark!">136.1 ms</span></i> (as of Aug 20, 2025),
346346
_flowR_ can analyze the data- and control-flow of the average real-world R script. See the [benchmarks](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark) for more information,
347347
and consult the [wiki pages](https://github.com/flowr-analysis/flowr/wiki/Dataflow-Graph) for more details on the dataflow graph.
348348
@@ -378,7 +378,7 @@ It offers a wide variety of features, for example:
378378
379379
```shell
380380
$ docker run -it --rm eagleoutice/flowr # or npm run flowr
381-
flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
381+
flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
382382
R> :dataflow* test/testfiles/example.R
383383
```
384384
@@ -679,7 +679,7 @@ It offers a wide variety of features, for example:
679679
```
680680
681681
682-
(The analysis required _14.3 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
682+
(The analysis required _14.0 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
683683
684684
685685

‎wiki/Core.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-core-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-core-wiki.ts)' on 2025-08-20, 08:45:35 UTC presenting an overview of flowR's core (v2.4.2, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-core-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-core-wiki.ts)' on 2025-08-20, 10:37:34 UTC presenting an overview of flowR's core (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22

33
This wiki page provides an overview of the inner workings of _flowR_.
44
It is mostly intended for developers that want to extend the capabilities of _flowR_
@@ -18,7 +18,7 @@ and the [Contributing Guidelines](https://github.com/flowr-analysis/flowr/tree/m
1818
>
1919
> ```shell
2020
> $ docker run -it --rm eagleoutice/flowr # or npm run flowr
21-
> flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
21+
> flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
2222
> R> :parse "x <- 1; print(x)"
2323
> ```
2424
>
@@ -220,7 +220,7 @@ To explore these steps, let's use the REPL with the (very simple and contrived)
220220
221221
```shell
222222
$ docker run -it --rm eagleoutice/flowr # or npm run flowr
223-
flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
223+
flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
224224
R> :parse "x <- 1; print(x)"
225225
```
226226
@@ -298,7 +298,7 @@ x"])
298298
299299
```
300300

301-
(The analysis required _10.7 ms_ (including parsing with the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
301+
(The analysis required _5.3 ms_ (including parsing with the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
302302

303303

304304

@@ -362,7 +362,7 @@ print`"]
362362
```
363363

364364

365-
(The analysis required _18.8 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
365+
(The analysis required _8.7 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
366366

367367

368368

@@ -395,7 +395,7 @@ Especially when you are just starting with flowR, we recommend using the REPL to
395395
>
396396
> ```shell
397397
> $ docker run -it --rm eagleoutice/flowr --default-engine tree-sitter # or npm run flowr -- --default-engine tree-sitter
398-
> flowR repl using flowR v2.4.2, R grammar v14 (tree-sitter engine)
398+
> flowR repl using flowR v2.4.3, R grammar v14 (tree-sitter engine)
399399
> R> :parse "x <- 1; print(x)"
400400
> ```
401401
>
@@ -470,7 +470,7 @@ Especially when you are just starting with flowR, we recommend using the REPL to
470470
>
471471
> ```
472472
>
473-
> (The analysis required _10.2 ms_ (including parsing with the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
473+
> (The analysis required _7.0 ms_ (including parsing with the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
474474
>
475475
>
476476
>
@@ -534,7 +534,7 @@ Especially when you are just starting with flowR, we recommend using the REPL to
534534
> ```
535535
>
536536
>
537-
> (The analysis required _4.0 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
537+
> (The analysis required _2.1 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
538538
>
539539
>
540540
>
@@ -1263,7 +1263,7 @@ You can explore the slicing using the REPL with the <span title="Description (Re
12631263
12641264
```shell
12651265
$ docker run -it --rm eagleoutice/flowr # or npm run flowr
1266-
flowR repl using flowR v2.4.2, R v4.5.0 (r-shell engine)
1266+
flowR repl using flowR v2.4.3, R v4.5.0 (r-shell engine)
12671267
R> :slicer test/testfiles/example.R --criterion "12@product"
12681268
```
12691269

0 commit comments

Comments
 (0)