Skip to content

Commit 26d6e5f

Browse files
committed
[skip ci] doc: update generated wiki pages (wiki/Interface)
1 parent 5ec7deb commit 26d6e5f

10 files changed

+67
-67
lines changed

wiki/Interface.md

Lines changed: 20 additions & 20 deletions
Large diffs are not rendered by default.

wiki/lint-absolute-file-paths.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:14 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:13 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="absolute-file-paths">Absolute Paths&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This rule may provide quickfixes to automatically fix the issues it detects."><a href='#quickfix'>![quickfix](https://img.shields.io/badge/quickfix-lightgray) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the portability of the code. For example, platform-specific code, or code that relies on specific R versions or packages."><a href='#robustness'>![robustness](https://img.shields.io/badge/robustness-teal) </a></span>
@@ -52,16 +52,16 @@ The linting query can be used to run this rule on the above example:
5252

5353
_Results (prettified and summarized):_
5454

55-
Query: **linter** (1 ms)\
55+
Query: **linter** (0 ms)\
5656
&nbsp;&nbsp;&nbsp;**Absolute Paths** (absolute-file-paths):\
5757
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
5858
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `C:/Users/me/Documents/My R Scripts/Reproducible.csv` at 2.1-63\
59-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":0}</code>\
60-
_All queries together required ≈1 ms (1ms accuracy, total 3 ms)_
59+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":0,"processTimeMs":0}</code>\
60+
_All queries together required ≈0 ms (1ms accuracy, total 4 ms)_
6161

6262
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
6363

64-
The analysis required _3.4 ms_ (including parsing and normalization and the query) within the generation environment.
64+
The analysis required _4.0 ms_ (including parsing and normalization and the query) within the generation environment.
6565

6666
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.
6767
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -89,17 +89,17 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
8989
".meta": {
9090
"totalConsidered": 1,
9191
"totalUnknown": 0,
92-
"searchTimeMs": 1,
92+
"searchTimeMs": 0,
9393
"processTimeMs": 0
9494
}
9595
}
9696
},
9797
".meta": {
98-
"timing": 1
98+
"timing": 0
9999
}
100100
},
101101
".meta": {
102-
"timing": 1
102+
"timing": 0
103103
}
104104
}
105105
```

wiki/lint-dataframe-access-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:16 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:15 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="dataframe-access-validation">Dataframe Access Validation&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect bugs in the code. Everything that affects the semantics of the code, such as incorrect function calls, wrong arguments, etc. is to be considered a bug. Otherwise, it may be a smell or a style issue."><a href='#bug'>![bug](https://img.shields.io/badge/bug-red) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -53,7 +53,7 @@ _All queries together required ≈3 ms (1ms accuracy, total 9 ms)_
5353

5454
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5555

56-
The analysis required _8.8 ms_ (including parsing and normalization and the query) within the generation environment.
56+
The analysis required _9.2 ms_ (including parsing and normalization and the query) within the generation environment.
5757

5858
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.
5959
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-dead-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:17 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:16 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="dead-code">Dead Code&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -46,11 +46,11 @@ Query: **linter** (1 ms)\
4646
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
4747
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Code at 1.17\
4848
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consideredNodes":7,"searchTimeMs":1,"processTimeMs":0}</code>\
49-
_All queries together required ≈1 ms (1ms accuracy, total 6 ms)_
49+
_All queries together required ≈1 ms (1ms accuracy, total 5 ms)_
5050

5151
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5252

53-
The analysis required _6.4 ms_ (including parsing and normalization and the query) within the generation environment.
53+
The analysis required _5.3 ms_ (including parsing and normalization and the query) within the generation environment.
5454

5555
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.
5656
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-deprecated-functions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:13 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:12 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="deprecated-functions">Deprecated Functions&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This signals the use of deprecated functions or features."><a href='#deprecated'>![deprecated](https://img.shields.io/badge/deprecated-teal) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -44,16 +44,16 @@ The linting query can be used to run this rule on the above example:
4444

4545
_Results (prettified and summarized):_
4646

47-
Query: **linter** (0 ms)\
47+
Query: **linter** (1 ms)\
4848
&nbsp;&nbsp;&nbsp;**Deprecated Functions** (deprecated-functions):\
4949
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
5050
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Function `dplyr::all_equal` at 4.1-31\
51-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":1,"totalDeprecatedFunctionDefinitions":1,"searchTimeMs":0,"processTimeMs":0}</code>\
52-
_All queries together required ≈0 ms (1ms accuracy, total 11 ms)_
51+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":1,"totalDeprecatedFunctionDefinitions":1,"searchTimeMs":0,"processTimeMs":1}</code>\
52+
_All queries together required ≈1 ms (1ms accuracy, total 10 ms)_
5353

5454
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5555

56-
The analysis required _10.7 ms_ (including parsing and normalization and the query) within the generation environment.
56+
The analysis required _10.4 ms_ (including parsing and normalization and the query) within the generation environment.
5757

5858
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.
5959
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -82,16 +82,16 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
8282
"totalDeprecatedCalls": 1,
8383
"totalDeprecatedFunctionDefinitions": 1,
8484
"searchTimeMs": 0,
85-
"processTimeMs": 0
85+
"processTimeMs": 1
8686
}
8787
}
8888
},
8989
".meta": {
90-
"timing": 0
90+
"timing": 1
9191
}
9292
},
9393
".meta": {
94-
"timing": 0
94+
"timing": 1
9595
}
9696
}
9797
```

wiki/lint-file-path-validity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:14 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:12 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="file-path-validity">File Path Validity&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect bugs in the code. Everything that affects the semantics of the code, such as incorrect function calls, wrong arguments, etc. is to be considered a bug. Otherwise, it may be a smell or a style issue."><a href='#bug'>![bug](https://img.shields.io/badge/bug-red) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the portability of the code. For example, platform-specific code, or code that relies on specific R versions or packages."><a href='#robustness'>![robustness](https://img.shields.io/badge/robustness-teal) </a></span>
@@ -57,11 +57,11 @@ Query: **linter** (1 ms)\
5757
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
5858
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `C:/Users/me/Documents/My R Scripts/Reproducible.csv` at 2.12-74\
5959
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":1,"processTimeMs":0}</code>\
60-
_All queries together required ≈1 ms (1ms accuracy, total 4 ms)_
60+
_All queries together required ≈1 ms (1ms accuracy, total 5 ms)_
6161

6262
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
6363

64-
The analysis required _4.5 ms_ (including parsing and normalization and the query) within the generation environment.
64+
The analysis required _4.6 ms_ (including parsing and normalization and the query) within the generation environment.
6565

6666
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.
6767
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-naming-convention.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:16 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:15 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="naming-convention">Naming Convention&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule may provide quickfixes to automatically fix the issues it detects."><a href='#quickfix'>![quickfix](https://img.shields.io/badge/quickfix-lightgray) </a></span> <span title="This rule is used to detect issues that are related to the style of the code. For example, inconsistent naming conventions, or missing or incorrect formatting."><a href='#style'>![style](https://img.shields.io/badge/style-teal) </a></span>
@@ -50,7 +50,7 @@ _All queries together required ≈0 ms (1ms accuracy, total 8 ms)_
5050

5151
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5252

53-
The analysis required _7.5 ms_ (including parsing and normalization and the query) within the generation environment.
53+
The analysis required _8.2 ms_ (including parsing and normalization and the query) within the generation environment.
5454

5555
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.
5656
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-seeded-randomness.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:22:15 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:36:14 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="seeded-randomness">Seeded Randomness&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the portability of the code. For example, platform-specific code, or code that relies on specific R versions or packages."><a href='#robustness'>![robustness](https://img.shields.io/badge/robustness-teal) </a></span>
@@ -50,12 +50,12 @@ Query: **linter** (1 ms)\
5050
&nbsp;&nbsp;&nbsp;**Seeded Randomness** (seeded-randomness):\
5151
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
5252
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Function `runif` at 1.1-8\
53-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":1,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":1}</code>\
53+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":1,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":1,"processTimeMs":0}</code>\
5454
_All queries together required ≈1 ms (1ms accuracy, total 3 ms)_
5555

5656
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5757

58-
The analysis required _3.1 ms_ (including parsing and normalization and the query) within the generation environment.
58+
The analysis required _3.0 ms_ (including parsing and normalization and the query) within the generation environment.
5959

6060
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.
6161
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -85,8 +85,8 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
8585
"callsWithFunctionProducers": 0,
8686
"callsWithAssignmentProducers": 0,
8787
"callsWithNonConstantProducers": 0,
88-
"searchTimeMs": 0,
89-
"processTimeMs": 1
88+
"searchTimeMs": 1,
89+
"processTimeMs": 0
9090
}
9191
}
9292
},

0 commit comments

Comments
 (0)