-
Notifications
You must be signed in to change notification settings - Fork 4
Improve LOG_FILE example #683
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.
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
Conversation
|
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. |
There was a problem hiding this 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.
I'm happy to make it more obvious that it's an example LOG_FILE path. +2⎕NQ#'GetEnvironment' 'LOG_FILE'
C:\Users\Silas\Documents\Dyalog APL-64 20.0 Unicode Files\default_*.dlfx |
|
@FionaDyalog your call to reject this issue or not |
windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md
Outdated
Show resolved
Hide resolved
windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md
Outdated
Show resolved
Hide resolved
FionaDyalog
left a comment
There was a problem hiding this 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.
windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md
Show resolved
Hide resolved
There was a problem hiding this 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.)
As #466 discusses, the example could be improved...