Show example outputs in System documentation #1416
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
This was referenced Dec 7, 2024
Open
Closed
GuillaumeGomez
approved these changes
Dec 7, 2024
|
More docs is always appreciated, so thanks a lot! |
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.
The scraped examples and existing documentation are not helpful at all in understanding how these functions relate under actual systems, e.g. understanding whether
format!("{} {}", System::name(), System::os_version())would produce something that is meaningful. Someone might try this on Linux and get "Ubuntu 24.04" and conclude it's good, but they end up producing nonsense like "Darwin 15.1.1" and "Pixel 9 15" on other systems.