Skip to content

Conversation

@bear8642
Copy link
Contributor

As #466 discusses, the example could be improved...

@bear8642 bear8642 self-assigned this Dec 18, 2025
@bear8642 bear8642 changed the title Correct log file sample Improve LOG_FILE example Dec 18, 2025
@bear8642 bear8642 linked an issue Dec 18, 2025 that may be closed by this pull request
@DyalogRichard
Copy link
Contributor

It's very unlikely the default location "is" `C:\Users<username>\Documents..." - it does not have to be on drive C, it is usually under One Drive these days, and non-English Windows possibly doesn't use the names Users or Documents. I think this bit should be shown to come from the system somehow and only spelled out in the example.

Copy link
Contributor

@DyalogRichard DyalogRichard left a comment

Choose a reason for hiding this comment

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

We're not really going to change the version number in the "for example" every release, are we? It's an example; if we're changing stuff here anyway by all means update it at that point, but #466 ("Documentation of LOG_FILE parameter shows a v19.0 path in sample") should be rejected, unless there is some kind of docs tool or macro which can substitute in the current version, whatever that may be.

Notwithstanding that, it has highlighted a different problem - the default is not "C:\Users<username>\Documents" - see comments elsewhere. Just adding a drive letter misses the point; to fix that the path should all be abstracted out somehow.

@bear8642
Copy link
Contributor Author

bear8642 commented Jan 2, 2026

It's very unlikely the default location "is" `C:\Users\Documents..." - it does not have to be on drive C, it is usually under One Drive these days [...] I think this bit should be shown to come from the system somehow and only spelled out in the example.

I'm happy to make it more obvious that it's an example LOG_FILE path.
Whilst a OneDrive file path is likely, it doesn't have to be and indeed isn't on my machine:

      +2⎕NQ#'GetEnvironment' 'LOG_FILE'
C:\Users\Silas\Documents\Dyalog APL-64 20.0 Unicode Files\default_*.dlfx

@bear8642
Copy link
Contributor Author

bear8642 commented Jan 2, 2026

@FionaDyalog your call to reject this issue or not

@FionaDyalog FionaDyalog self-requested a review January 5, 2026 09:35
Copy link
Contributor

@FionaDyalog FionaDyalog left a comment

Choose a reason for hiding this comment

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

Approved on the assumption that suggested changes are implemented, otherwise please request re-review.

@bear8642 bear8642 requested a review from DyalogRichard January 8, 2026 14:11
Copy link
Contributor

@DyalogRichard DyalogRichard left a comment

Choose a reason for hiding this comment

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

Two very minor typos - approval subject to those being fixed:

[1] "In this situation, at start-up, Dyalog attempts to open, and then locks, a file". To be gramattically correct, remove the "s" from the end of "locks".

[2] The default Log_File setting should have an underscore after "default" (i.e. "...\default_*.dlfx".

(Technically, the default Log_File setting should not be shown as "-<bits>" either, because on 32-bit neither the "-" or "32" is present, but that's too complicated and too unimportant to fix, I reckon.)

@bear8642 bear8642 merged commit 4ad63c6 into main Jan 8, 2026
@bear8642 bear8642 deleted the 466-correct-log-file-sample branch January 8, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation of LOG_FILE parameter shows a v19.0 path in sample

4 participants