Skip to content

Commit 61a0247

Browse files
committed
[skip ci] doc: update generated wiki pages (wiki/Interface)
1 parent 304d474 commit 61a0247

8 files changed

+55
-55
lines changed

wiki/Interface.md

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

wiki/lint-absolute-file-paths.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-07-21, 07:09:36 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:54 UTC presenting an overview of flowR's linter (v2.2.16, 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>
@@ -54,11 +54,11 @@ Query: **linter** (1 ms)\
5454
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ definitely:\
5555
&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\
5656
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":0}</code>\
57-
_All queries together required ≈1 ms (1ms accuracy, total 7 ms)_
57+
_All queries together required ≈1 ms (1ms accuracy, total 6 ms)_
5858

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

61-
The analysis required _6.6 ms_ (including parsing and normalization and the query) within the generation environment.
61+
The analysis required _6.2 ms_ (including parsing and normalization and the query) within the generation environment.
6262

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

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-07-21, 07:09:38 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:56 UTC presenting an overview of flowR's linter (v2.2.16, 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>
@@ -50,7 +50,7 @@ _All queries together required ≈4 ms (1ms accuracy, total 13 ms)_
5050

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

53-
The analysis required _12.8 ms_ (including parsing and normalization and the query) within the generation environment.
53+
The analysis required _13.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-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-07-21, 07:09:34 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:53 UTC presenting an overview of flowR's linter (v2.2.16, 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>
@@ -41,16 +41,16 @@ The linting query can be used to run this rule on the above example:
4141

4242
_Results (prettified and summarized):_
4343

44-
Query: **linter** (1 ms)\
44+
Query: **linter** (0 ms)\
4545
&nbsp;&nbsp;&nbsp;**Deprecated Functions** (deprecated-functions):\
4646
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ definitely:\
4747
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Function `dplyr::all_equal` at 4.1-31\
48-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":1,"totalDeprecatedFunctionDefinitions":1,"searchTimeMs":0,"processTimeMs":1}</code>\
49-
_All queries together required ≈1 ms (1ms accuracy, total 10 ms)_
48+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":1,"totalDeprecatedFunctionDefinitions":1,"searchTimeMs":0,"processTimeMs":0}</code>\
49+
_All queries together required ≈0 ms (1ms accuracy, total 10 ms)_
5050

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

53-
The analysis required _9.8 ms_ (including parsing and normalization and the query) within the generation environment.
53+
The analysis required _10.0 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.
@@ -79,16 +79,16 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
7979
"totalDeprecatedCalls": 1,
8080
"totalDeprecatedFunctionDefinitions": 1,
8181
"searchTimeMs": 0,
82-
"processTimeMs": 1
82+
"processTimeMs": 0
8383
}
8484
}
8585
},
8686
".meta": {
87-
"timing": 1
87+
"timing": 0
8888
}
8989
},
9090
".meta": {
91-
"timing": 1
91+
"timing": 0
9292
}
9393
}
9494
```

wiki/lint-file-path-validity.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-07-21, 07:09:35 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:54 UTC presenting an overview of flowR's linter (v2.2.16, 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>
@@ -49,16 +49,16 @@ The linting query can be used to run this rule on the above example:
4949

5050
_Results (prettified and summarized):_
5151

52-
Query: **linter** (1 ms)\
52+
Query: **linter** (0 ms)\
5353
&nbsp;&nbsp;&nbsp;**File Path Validity** (file-path-validity):\
5454
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ definitely:\
5555
&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\
56-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":1,"processTimeMs":0}</code>\
57-
_All queries together required ≈1 ms (1ms accuracy, total 4 ms)_
56+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":0,"processTimeMs":0}</code>\
57+
_All queries together required ≈0 ms (1ms accuracy, total 4 ms)_
5858

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

61-
The analysis required _3.6 ms_ (including parsing and normalization and the query) within the generation environment.
61+
The analysis required _3.9 ms_ (including parsing and normalization and the query) within the generation environment.
6262

6363
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.
6464
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -88,17 +88,17 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
8888
"totalUnknown": 0,
8989
"totalWritesBeforeAlways": 0,
9090
"totalValid": 0,
91-
"searchTimeMs": 1,
91+
"searchTimeMs": 0,
9292
"processTimeMs": 0
9393
}
9494
}
9595
},
9696
".meta": {
97-
"timing": 1
97+
"timing": 0
9898
}
9999
},
100100
".meta": {
101-
"timing": 1
101+
"timing": 0
102102
}
103103
}
104104
```

wiki/lint-naming-convention.md

Lines changed: 1 addition & 1 deletion
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-07-21, 07:09:37 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:56 UTC presenting an overview of flowR's linter (v2.2.16, 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>

wiki/lint-seeded-randomness.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-07-21, 07:09:37 UTC presenting an overview of flowR's linter (v2.2.16, 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-07-21, 07:29:55 UTC presenting an overview of flowR's linter (v2.2.16, 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>
@@ -43,16 +43,16 @@ The linting query can be used to run this rule on the above example:
4343

4444
_Results (prettified and summarized):_
4545

46-
Query: **linter** (1 ms)\
46+
Query: **linter** (0 ms)\
4747
&nbsp;&nbsp;&nbsp;**Seeded Randomness** (seeded-randomness):\
4848
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ definitely:\
4949
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Function `runif` at 1.1-8\
50-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":1,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":1,"processTimeMs":0}</code>\
51-
_All queries together required ≈1 ms (1ms accuracy, total 3 ms)_
50+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":1,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":0}</code>\
51+
_All queries together required ≈0 ms (1ms accuracy, total 3 ms)_
5252

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

55-
The analysis required _2.8 ms_ (including parsing and normalization and the query) within the generation environment.
55+
The analysis required _3.0 ms_ (including parsing and normalization and the query) within the generation environment.
5656

5757
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.
5858
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -82,17 +82,17 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
8282
"callsWithFunctionProducers": 0,
8383
"callsWithAssignmentProducers": 0,
8484
"callsWithNonConstantProducers": 0,
85-
"searchTimeMs": 1,
85+
"searchTimeMs": 0,
8686
"processTimeMs": 0
8787
}
8888
}
8989
},
9090
".meta": {
91-
"timing": 1
91+
"timing": 0
9292
}
9393
},
9494
".meta": {
95-
"timing": 1
95+
"timing": 0
9696
}
9797
}
9898
```

0 commit comments

Comments
 (0)