[Docs] Improve speedgraphs' scale description #1670
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
✅ Deploy Preview for conkyweb ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
the
documentation
brndnmtthws
reviewed
Nov 3, 2023
doc/variables.yaml
Outdated
| @@ -2253,8 +2253,8 @@ values: | |||
| similar fashion as TZ environment variable. For hints, look in | |||
| /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc. | |||
| args: | |||
| - (timezone | |||
| - (format)) | |||
| - (timezone) | |||
There was a problem hiding this comment.
Ohh, I see what happened here. I think we should probably do (timezone (format)) on one line, as the current scheme doesn't really account for nested args like this.
There was a problem hiding this comment.
Oh, my bad. Just fixed it 👍🏼
elamperti
force-pushed
the
speedgraphs-docs
branch
from
17c5534
to
402e983
Compare
brndnmtthws
approved these changes
Nov 8, 2023
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.
Checklist
doc/has been updatedDescription
Describe the changes, why they were necessary, etc
The
upspeedgraphanddownspeedgraphdocumentation was missing information on how the scale works. I was trying to set a correct scale, and in practice this value ends up setting the maximum value for the Y axis, in bytes per second (I gathered this fromnet_stat.hand testing empirically with known network values in my PC).I've also fixed a typo in the args of
tztime(misplaced parenthesis)Describe how the changes will affect existing behaviour.
This change doesn't change the behaviour of the application.
Describe how you tested and validated your changes.
I haven't tested this change, but
cmakecompiled everything ok on this branch.Include any relevant screenshots/evidence demonstrating that the changes work and have been tested.
Let me know if I need to share anything else for this change! :)