Documentation of <source> improved

aplteam · Jun 24, 2024 · 2d3de10 · 2d3de10
1 parent 1a44785
commit 2d3de10
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 7 deletions.
diff --git a/APLSource/Cider/History.apla b/APLSource/Cider/History.apla
@@ -6,8 +6,9 @@
  '  * Test cases added for ]addTatinDependencies'
  '  * NuGet-related test cases of the UC-group improved'
  '  * Message improved when the Cider config file of an open project is changed'
+ '  * Documentation regarding `source` improved'
  '  * Bug fixes'
- '    * ]Cider.ProjectConfig did not accepts an -edit flag    '
+ '    * ]Cider.ProjectConfig did not accepts an -edit flag when it should have    '
  '* 0.40.1 ⋄ 2024-06-18'
  '  * NuGet-related test cases are now executed in their own, independent process'
  '  * Error messages for `Init` functions of a project improved'

diff --git a/APLSource/Cider/Version.aplf b/APLSource/Cider/Version.aplf
@@ -1,3 +1,3 @@
  r←Version
 ⍝ See also `History`
- r←'0.41.0-beta-7+671'
+ r←'0.41.0+671'
diff --git a/apl-package.json b/apl-package.json
@@ -21,5 +21,5 @@
   tags: "project-management",
   tatin_version: "0.103.0",
   userCommandScript: "APLSource/Cider_UC.dyalog",
-  version: "0.41.0+746",
+  version: "0.41.0+747",
 }
diff --git a/docs/Cider-User-Guide.md b/docs/Cider-User-Guide.md
@@ -329,9 +329,11 @@ With the user command, this can be overwritten temporarily with, say:
 
 ###### source
 
-Defaults to `APLSource`: a subfolder that hosts the code. That's where the code lives, relative to the project folder. 
+Defaults to `APLSource`: a subfolder that hosts all APL code. Its relative to the project folder. 
 
-This might be empty, for example when the project is just a single script (class or namespace).
+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.
+
+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.
 
 ###### dependencies
 
@@ -841,5 +843,6 @@ An example:
 
 
 
+
 
 
diff --git a/html/Cider-User-Guide.html b/html/Cider-User-Guide.html
@@ -487,8 +487,9 @@ <h6 data-id="projectSpace">2.6.1.1.3. projectSpace</h6>
 <h6 data-id="source">2.6.1.1.4. source</h6>
 </a>
 </div>
-<p>Defaults to <code>APLSource</code>: a subfolder that hosts the code. That's where the code lives, relative to the project folder.</p>
-<p>This might be empty, for example when the project is just a single script (class or namespace).</p>
+<p>Defaults to <code>APLSource</code>: a subfolder that hosts all APL code. Its relative to the project folder.</p>
+<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>
+<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>
 <div class="h_tag">
 <a href="#dependencies" id="dependencies" class="autoheader_anchor">
 <h6 data-id="dependencies">2.6.1.1.5. dependencies</h6>