Skip to content

979 system documentation errors #983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abrudz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

979 system documentation errors #983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c47e44
Address #979
abrudz Aug 6, 2026
72e4395
Update system.md
abrudz Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions language-reference-guide/docs/system-functions/system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Getting the currently running APL interpreter's version number:
The result `R` is a namespace in the root of the namespace where `⎕SYSTEM` was called (`#` or `⎕SE`) and contains only namespace members. Each sub-namespace contains only variable members.

!!! Info "Information"
More members might be added in a future release of Dyalog, but `R` will remain serialisable using [`1⎕JSON`](json.md).
More members might be added in a future release of Dyalog, but `R` will remain serialisable using [`1∘⎕JSON`](json.md).

@DyalogRichard DyalogRichard Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still has the problem that it assumes it will remain serialisable, and there is every reason to suppose it might not.


!!! Warning "Warning"
Do attempt to add or modify members as changes will not be persisted. Instead, clone the namespace using `⎕NS ⎕SYSTEM` and modify the result, but note that this locks down dynamic values like `⎕SYSTEM.Directories.Current` and `⎕SYSTEM.OS.UTCOffset`.
Expand Down Expand Up @@ -76,7 +76,7 @@ This namespace provides information about the specific interpreter instance in w
Indicates whether the interpreter is a 64- or 32-bit application.

!!! Warning "Warning"
Do not confuse this with the bit width of the operating system; 64-bit operating systems can run 32-bit interpreters (but not the other way round).
Do not confuse this with the bit width of the operating system; some 64-bit operating systems can run 32-bit interpreters (but not the other way round).

#### Executable.BuildTarget
_For Dyalog internal use only._
Expand Down Expand Up @@ -152,7 +152,7 @@ Boolean indicating whether (`1`) or not (`0`) [Object Linking and Embedding](../
Full version of the built-in [Perl Compatible Regular Expressions](../pcre-specifications) engine, for example `10 47`.

!!! Hint "Hints and Recommendations"
Whether (`1`) or not (`0`) PCRE2 is in use is given by `10≤⎕SYSTEM.Features.PCRE`.
Whether (`1`) or not (`0`) PCRE1 is in use is given by `8≥⊃⎕SYSTEM.Features.PCRE`.

@DyalogRichard DyalogRichard Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can still never be true.


### Host
This namespace provides information about network identity.
Expand Down Expand Up @@ -226,10 +226,10 @@ The character used to separate multiple filenames in a single character vector.
The preferred file extension for [shared libraries](https://en.wikipedia.org/wiki/Shared_library) – one of `'.dll'` (Microsoft Windows), `'.dylib'` (macOS), or `'.so'` (Linux).

#### OS.UTCOffset
The number of hours by which the local time zone is offset from [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
The number of hours by which the current local time zone (with [daylight saving time](https://en.wikipedia.org/wiki/Daylight_saving_time) taken into account) is offset from [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

!!! Hint "Hints and Recommendations"
A positive number means the local time zone is ahead of UTC. A negative number means behind UTC. For example, if `⎕OS.UTCOffset` is `10`, then when it is noon UTC (12:00), it is 10 PM local time (`12+10`, that is, 22:00).
For example, if `⎕OS.UTCOffset` is `¯3`, then when it is 10:00 UTC, it is 07:00 local time (`10+¯3`).

@FionaDyalog FionaDyalog Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this one needs to be a hint, just standard text.

@DyalogRichard DyalogRichard Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is needed at all.


#### OS.Version
A three-element integer vector:
Expand All @@ -239,7 +239,7 @@ A three-element integer vector:
- AIX: version and release number, followed by a `0`

!!! Warning "Warning"
Windows 11 identifies itself as "Windows 10". Whether (`1`) or not (`0`) Windows 10 is in use is given by `1 0 1≡10 22000⍸⎕SYSTEM.OS.Version`.
Windows 11 identifies itself as "Windows 10". Whether (`1`) or not (`0`) Windows 10 is in use is given by `1 0 2≡10 11 21999⍸⎕SYSTEM.OS.Version`.

@FionaDyalog FionaDyalog Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs further clarification, as the first sentence implies that the second one could refer to Windows 10 or Windows 11.


#### OS.VolumeSeparator
The character used to separate the [volume](https://en.wikipedia.org/wiki/Volume_(computing)) from the rest of a file path – one of `'/'` or `':'`.
Expand Down