Skip to content

Commit

Permalink
Documentation regarding TatinVars updated
Browse files Browse the repository at this point in the history
  • Loading branch information
aplteam committed Dec 26, 2024
1 parent c051a70 commit 3f4e896
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion apl-package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@
tags: "project-management",
tatin_version: "0.103.0",
userCommandScript: "APLSource/Cider_UC.dyalog",
version: "0.46.0-beta-18+866",
version: "0.46.0-beta-19+867",
}
3 changes: 2 additions & 1 deletion docs/Cider-User-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ However, a programmer would expect a namespace `TatinVars` in the root of the _p

This can be addressed by adding the optional property "tatinVars" into the `CIDER` section of the Cider config file, holding the name of a sub-namespace that will eventually become the package.

If a property "tatinVars" does exist and points to a sub-namespace, then Cider will create a reference `TatinVars` in that namespace that points to `TatinVars` in the root of the project.
If a property "tatinVars" does exist and points to a sub-namespace, then Cider will ~~create a reference `TatinVars` in that namespace that points to `TatinVars` in the root of the project.~~ move the namespace from the root of the project to that sub-namespace.

#### Changing the current directory

Expand Down Expand Up @@ -852,5 +852,6 @@ An example:






4 changes: 2 additions & 2 deletions html/Cider-User-Guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@


</script>

<meta name="author" content="kai">
</head>
<body>
<div class="h_tag">
Expand Down Expand Up @@ -758,7 +758,7 @@ <h4 data-id="Injecting-a-namespace-TatinVars">2.7.9. Injecting a namespace <code
<p>If such a file is present, Cider injects a namespace <code>TatinVars</code> into the root of the project, containing exactly the same pieces of information as if it were loaded as a package. This allows a developer to access <code>TatinVars</code> as if it was loaded as a package while working on the project.</p>
<p>However, a programmer would expect a namespace <code>TatinVars</code> in the root of the <em>package</em>. That might be the root of a project, but it might as well be a <em>sub-namespace</em> of the project. In fact, that is more likely.</p>
<p>This can be addressed by adding the optional property “tatinVars” into the <code>CIDER</code> section of the Cider config file, holding the name of a sub-namespace that will eventually become the package.</p>
<p>If a property “tatinVars” does exist and points to a sub-namespace, then Cider will create a reference <code>TatinVars</code> in that namespace that points to <code>TatinVars</code> in the root of the project.</p>
<p>If a property “tatinVars” does exist and points to a sub-namespace, then Cider will <del>create a reference <code>TatinVars</code> in that namespace that points to <code>TatinVars</code> in the root of the project.</del> move the namespace from the root of the project to that sub-namespace.</p>
<div class="h_tag">
<a href="#changing-the-current-directory" id="changing-the-current-directory" class="autoheader_anchor">
<h4 data-id="Changing-the-current-directory">2.7.10. Changing the current directory</h4>
Expand Down

0 comments on commit 3f4e896

Please sign in to comment.