Skip to content

Commit

Permalink
Documentation polished
Browse files Browse the repository at this point in the history
  • Loading branch information
aplteam committed Dec 19, 2023
1 parent c57e909 commit ca1fc41
Show file tree
Hide file tree
Showing 196 changed files with 3,379 additions and 155 deletions.
16 changes: 16 additions & 0 deletions APLSource/Admin/CreateUserCommandHelpForProofreading.aplf
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
CreateUserCommandHelpForProofreading;cmdList;help2;help3
Compiles all the help into a single file for easier proof-reading
cmdList⎕SE.UCMD'Cider -??'
cmdList(⎕UCS 13)()cmdList
cmdList(/¨'CIDER:'¨cmdList)cmdList
cmdList(+/\(cmdList)[;1 2].=' ')cmdList
cmdList##.Cider.APLTreeUtils2.DLB cmdList
cmdList{¨¨' '}cmdList
help2{⎕SE.UCMD }¨cmdList,¨' -??'
help2{1<: (⎕UCS 13)()}¨help2
help2{().=''}¨help2
(1¨help2)('### '),¨1¨help2
help2('# Cider Help' '## Level 2'),,/help2
help3{⎕SE.UCMD }¨cmdList,¨' -???'
∘∘∘ TODO⍝ ⍝TODO⍝ Work in progress
Done
1 change: 1 addition & 0 deletions APLSource/Cider/API/GetCiderAliasFileContent.aplf
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
GetCiderAliasFileContent{ ##.GetCiderAliasFileContent }
1 change: 0 additions & 1 deletion APLSource/Cider/API/GetProjectPath.aplf

This file was deleted.

2 changes: 1 addition & 1 deletion APLSource/Cider/CreateOpenParms.aplf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
parmsCreateOpenParms dummy;list;b;l
parmsCreateOpenParms y;list;b;l
Creates a namespace with all parameters one might pass to `OpenProject`.\\
`y` might be an empty vector or a namespace with some such parameters.
Any parameters passed this way overwrite defaults.
Expand Down
3 changes: 3 additions & 0 deletions APLSource/Cider/History.apla
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
' * BREAKING CHANGE: API function `GetAliasFileContent` renamed: `GetCiderAliasFileContent`'
' * Optional property `tatinVars` added to the Cider config file and `InjectTatinVars` changed accordingly'
' * `CheckTargetNamespaceAndLinkFolder` improved in terms of error messages and better questions '
' * Documentation improved'
' * New version of FilesAndDirs integrated which addresses the problem that RmDirByForce with ''/..'' dir not'
' work on Linux and Mac OS.'
' * Bug fix in `InjectTatinVars`: TatinVars was injected into the project root rather than the package root'
'* 0.37.5 ⋄ 2023-11-07'
' * Bug fixes'
Expand Down
4 changes: 2 additions & 2 deletions APLSource/TestCases/CheckTempDirForLeftOvers.aplf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
F#.Cider.Cider.FilesAndDirs
:If 0<listF.ListDirs F.GetTempPath,'Cider-Tests*'
:AndIf ~/'_Alias_'testFnName The group "Alias" cleans up in the Cleanup_Alias function
⎕TRAP0 'S'
∘∘∘
⎕TRAP←0 'S'
∘∘∘
:EndIf
Done
8 changes: 6 additions & 2 deletions APLSource/TestCases/Initial_NuGet.aplf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
r{x}Initial_NuGet ps;info
r{x}Initial_NuGet ps;info;rc
r9=⎕NC'⎕SE.NuGet'
info''
:If ~r ⎕se.NuGet not found and...
info'⎕SE.NuGet is not available, so the NuGet tests can not be executed.' ... so we inform the user
:EndIf
:Select 122500
:Select 1rc22500
:Case ¯1
r0
info'.NET interface is not supported.'
Expand All @@ -15,8 +15,12 @@
r0
info'The .NET interface is configured to use .NET Framework - incompatible with NuGet.'
:EndSelect
:If 0=2rc
info'Could not load the .NET bridge interface.'
:EndIf
:If ~ps.batchFlag
:AndIf 0<info
CommTools.Pause info,(⎕UCS 13),'Therefore the NuGet tests cannot be executed.'
r0
:EndIf
Done
2 changes: 1 addition & 1 deletion APLSource/TestCases/Test_OpenAndClose_001.aplf
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
listFilesAndDirs.ListFiles projectFolder2
T.GoToTidyUp 1list
T.GoToTidyUp'cider.config',/1⎕NPARTS 1list
aliase##.Cider.GetCCiderAliasFileContent
aliase##.Cider.GetCiderAliasFileContent
T.GoToTidyUp~/(⎕C'test-case-alias-Foo' 'test-case-alias-Goo')aliase[;1]

T.GoToTidyUp 1##.Cider.CloseProject'#.Foo'
Expand Down
2 changes: 1 addition & 1 deletion APLSource/TestCases/Test_UC_030.aplf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Delete_∆ALIAS_TEMP_FOLDER
(rc msg res)∆UCMD'ListAliases -prune -batch'
Assert rc=0
mat2##.Cider.GetAliasFileContent
mat2##.Cider.GetCiderAliasFileContent
T.PassesIf(+/~⎕NEXISTS mat1[;2])=-/¨mat1 mat2

RT._OK
Expand Down
2 changes: 1 addition & 1 deletion Tests/Test_Open_051/packages/apl-buildlist.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
packageID: [
"aplteam-APLTreeUtils2-1.3.0",
"aplteam-APLTreeUtils2-1.3.1",
],
principal: [
1,
Expand Down
2 changes: 1 addition & 1 deletion Tests/Test_Open_051/packages/apl-dependencies.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
aplteam-APLTreeUtils2-1.3.0
aplteam-APLTreeUtils2-1.3.1
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,34 @@
While `APLTreeUtils` was a namespace scipt designed to be included into pretty much every member of the
APLTree library, `APLTreeUtils2` is a class with shared methods. You are supposed to call those methods.
This has some major advantageous over the old approach:
* It's possible to add new functions to `APLTreeUtils`. With the old approach there was always the possibility
* It's possible to add new functions to `APLTreeUtils2`. With the old approach there was always the possibility
of a name clash, so adding new function was practically impossible.
* The sequence of fixing does not matter (though with lazy fixing that should not be an issue anymore anyway,
but at the time of writing it still is).
* Over the years we have seen rare `⎕IO` and `⎕ML` issues with `:Include`. We just avoid the possibility now.\\
For a list with the precise differences between `APLTreeUtils` and `APLTreeUtils2` see the project ReadMe on
GitHub. Note that there are many. Most importantly, `APLTreeUtils2` requires Dyalog 18.0.
GitHub. Note that there are many. Most importantly, `APLTreeUtils2` requires at least Dyalog 18.0.
Kai Jaeger\\
Homepage: <https://github.com/aplteam/APLTreeUtils2/>

⎕ML⎕IO1

rVersion
:Access Public Shared
r'APLTreeUtils2' '1.2.0+62' '2023-05-08'
r'APLTreeUtils2' '1.3.1+62' '2023-12-11'

History
* 1.3.1 from 2023-12-01
* `CreateUUID` required to set `⎕RL` due to the fact that the seed is the same in every new namespace.
* 1.3.0 from 2023-11-05
* `ToNum` now accepts a left argument which is returned in case the right argument is an empty vector.
* New methods: `BitsToInt` and `IntToBits`
* 1.2.2 from 2023-10-09
* Minor fix in CreateUUID
* License corrected
* 1.2.1 from 2023-10-05
* Bug fix in `Create_UUID`
* 1.2.0 from 2023-05-08
* Bug fix: version number corrected
* 1.1.4 from 2023-04-09
Expand Down Expand Up @@ -65,10 +75,16 @@
r0 210|⎕DR y

rToNum y
Transforms `y` into number(s)
r{default}ToNum y
Transforms `y` into number(s).\\
In case `y` is empty `default` is returned which defaults to ⍬ (empty numeric vector).
:Access Public Shared
r(//)⎕VFI y
:If 0=y
:AndIf 0<⎕NC'default'
rdefault
:Else
r(//)⎕VFI y
:EndIf

rIsScripted y
Expand Down Expand Up @@ -297,11 +313,11 @@
r3'.'⎕WG'APLVersion'

rCreate_UUID;⎕RL
rCreate_UUID
Produces a UUID
:Access Public Shared
⎕RL+/⎕TS
r'-'@(+\9,35)(⎕D,⎕C ⎕A)[?3616]
⎕RL[1]
r'-'@(4+5×4)(⎕D,⎕C ⎕A)[4(9+|)@205@15?3616]

r{type}Base64 txt;charset
Expand Down Expand Up @@ -419,4 +435,18 @@
cats''four¨24 part 8 bits
}

rBitsToInt y
Unsigned
:Access Public Shared
r(322)32y


rIntToBits y
Unsigned
:Access Public Shared
r(322)y


:EndClass
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
api: "APLTreeUtils2",
assets: "",
date: 20230508.171103,
date: 20231210.133211,
description: "General utilities required by most members of the APLTree library",
documentation: "",
files: "",
Expand All @@ -21,5 +21,5 @@
tags: "tools,utilities",
uri: "https://tatin.dev/",
userCommandScript: "",
version: "1.2.0+68",
version: "1.3.1+76",
}
2 changes: 1 addition & 1 deletion apl-package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
tags: "project-management",
tatin_version: "0.103.0",
userCommandScript: "APLSource/Cider_UC.dyalog",
version: "0.38.0+656",
version: "0.38.0+659",
}
5 changes: 3 additions & 2 deletions docs/Cider-API-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ Returns the number of projects closed.
## CreateOpenParms

```
parms←CreateOpenParms dummy
parms←CreateOpenParms y
```

A monadic function that returns a namespace with default parameters required by the `OpenProject` function. The right argument is ignored.
A monadic function that returns a namespace with default parameters required by the `OpenProject` function. The right argument might be either an empty vector (which is ignored) or a namespace holding some of the parameters. In the latter case the values are copied over.


```
Expand Down Expand Up @@ -495,3 +495,4 @@ This can be just `1.2.3`, but it may be something like `1.2.3-beta-1+113`




Loading

0 comments on commit ca1fc41

Please sign in to comment.