docs(barchart): add documentation to BarChart
#449
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
Valentin271
requested review from
orhun,
mindoodoo,
sayanarijit,
sophacles,
joshka and
kdheepak
as code owners
Codecov Report
@@ Coverage Diff @@
## main #449 +/- ##
==========================================
- Coverage 90.42% 90.00% -0.42%
==========================================
Files 40 40
Lines 11079 11156 +77
==========================================
+ Hits 10018 10041 +23
- Misses 1061 1115 +54
|
joshka
requested changes
Aug 28, 2023
There was a problem hiding this comment.
Generally looking good (none of my feedback is blocking - purely gold plating).
Would you consider adding examples even for the simple methods? My rationale for this is that examples help newer users discover things like how to write styles, do things idiomatically (e.g. Style::new().red() or "foo".into()), and discover other Ratatui modules (like the symbols module
9 tasks
Valentin271
force-pushed
the
docs/barchart
branch
from
dd3046c to
e2b8d90
Compare
|
Most of it should be fixed. Here's an updated screenshot of the
|
Valentin271
force-pushed
the
docs/barchart
branch
from
e2b8d90 to
c31c27a
Compare
karthago1
reviewed
Aug 31, 2023
Add documentation to the `BarChart` widgets and its sub-modules.
Valentin271
force-pushed
the
docs/barchart
branch
from
c31c27a to
09c974b
Compare
karthago1
approved these changes
Sep 1, 2023
joshka
approved these changes
Sep 1, 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.
Add documentation to the
BarChartwidgets and its sub-modules.Relates to #386.
Screenshots