Skip to content

Commit 67e821f

Browse files
committed
Documentation of <source> improved
1 parent 1a44785 commit 67e821f

File tree

5 files changed

+12
-7
lines changed

5 files changed

+12
-7
lines changed

APLSource/Cider/History.apla

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
' * Test cases added for ]addTatinDependencies'
77
' * NuGet-related test cases of the UC-group improved'
88
' * Message improved when the Cider config file of an open project is changed'
9+
' * Documentation regarding `source` improved'
910
' * Bug fixes'
10-
' * ]Cider.ProjectConfig did not accepts an -edit flag '
11+
' * ]Cider.ProjectConfig did not accepts an -edit flag when it should have '
1112
'* 0.40.1 ⋄ 2024-06-18'
1213
' * NuGet-related test cases are now executed in their own, independent process'
1314
' * Error messages for `Init` functions of a project improved'

APLSource/Cider/Version.aplf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
r←Version
22
⍝ See also `History`
3-
r←'0.41.0-beta-7+671'
3+
r←'0.41.0+671'

apl-package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@
2121
tags: "project-management",
2222
tatin_version: "0.103.0",
2323
userCommandScript: "APLSource/Cider_UC.dyalog",
24-
version: "0.41.0+746",
24+
version: "0.41.0+747",
2525
}

docs/Cider-User-Guide.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,11 @@ With the user command, this can be overwritten temporarily with, say:
329329

330330
###### source
331331

332-
Defaults to `APLSource`: a subfolder that hosts the code. That's where the code lives, relative to the project folder.
332+
Defaults to `APLSource`: a subfolder that hosts all APL code. Its relative to the project folder.
333333

334-
This might be empty, for example when the project is just a single script (class or namespace).
334+
This might be empty, for example when the project is just a single script (class or namespace) that lives in the root of the project.
335+
336+
Note that this might be different from Tatin `source` parameter, which might point to a sub-folder of Cider's `source` hosting just the code that is a package. Cider's `source` might also contain test cases, development tools and whatnot.
335337

336338
###### dependencies
337339

@@ -841,5 +843,6 @@ An example:
841843
842844
843845
846+
844847
845848

html/Cider-User-Guide.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,8 +487,9 @@ <h6 data-id="projectSpace">2.6.1.1.3. projectSpace</h6>
487487
<h6 data-id="source">2.6.1.1.4. source</h6>
488488
</a>
489489
</div>
490-
<p>Defaults to <code>APLSource</code>: a subfolder that hosts the code. That's where the code lives, relative to the project folder.</p>
491-
<p>This might be empty, for example when the project is just a single script (class or namespace).</p>
490+
<p>Defaults to <code>APLSource</code>: a subfolder that hosts all APL code. Its relative to the project folder.</p>
491+
<p>This might be empty, for example when the project is just a single script (class or namespace) that lives in the root of the project.</p>
492+
<p>Note that this might be different from Tatin <code>source</code> parameter, which might point to a sub-folder of Cider's <code>source</code> hosting just the code that is a package. Cider's <code>source</code> might also contain test cases, development tools and whatnot.</p>
492493
<div class="h_tag">
493494
<a href="#dependencies" id="dependencies" class="autoheader_anchor">
494495
<h6 data-id="dependencies">2.6.1.1.5. dependencies</h6>

0 commit comments

Comments
 (0)