Information for specific operating system #46438
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To not cause ambiguities, when a message is going to a specific operating system, say windows, its best to be spelled out explicitly if possible, so the reader on the docs can know what's happening, other than assuming with the prefix of `win`, one would immediately figure out its talking about windows.
KristofferC
reviewed
Aug 24, 2022
KristofferC
reviewed
Aug 24, 2022
Co-authored-by: Kristoffer Carlsson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To not cause ambiguities, when a message is going to a specific operating system, say windows, its will be best if an info is spelled at the top indicating its for windows user or a note on a bracket saying this is available for windows users only, so the reader on the docs can know what's happening, other than assuming with the prefix of
win, one would immediately figure out its talking about Windows.If this culture persists of using just
winand is ingrained into every first time user on Julia, packages using names whose prefix starts withwinbase on related field, might be mistaken for talking about a Windows thing and would cause a lot of bugs where different aspects of the package and windows functionality needs to be added together. Another reason is that when its talking about MacOs, noMacprefix is applied, causing more ambiguities.