Skip to content
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

docs(list): add documentation to the List widget #669

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

Valentin271
Copy link
Member

Adds documentation to the List widget and all its sub components like ListState and ListItem

Relates to #386

Screenshots

List

image

ListItem

image

ListState

image

@Valentin271 Valentin271 added the Type: Documentation Improvements or additions to documentation label Dec 6, 2023
@Valentin271 Valentin271 added this to the v0.25.0 milestone Dec 6, 2023
Copy link

codecov bot commented Dec 6, 2023

Codecov Report

Attention: 8 lines in your changes are missing coverage. Please review.

Comparison is base (dd22e72) 90.9% compared to head (6eb4966) 90.8%.
Report is 1 commits behind head on main.

Files Patch % Lines
src/widgets/list.rs 27.2% 8 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##            main    #669     +/-   ##
=======================================
- Coverage   90.9%   90.8%   -0.1%     
=======================================
  Files         42      42             
  Lines      12533   12545     +12     
=======================================
+ Hits       11394   11403      +9     
- Misses      1139    1142      +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/widgets/list.rs Outdated Show resolved Hide resolved
Adds documentation to the List widget and all its sub components like `ListState` and `ListItem`
@orhun orhun changed the title docs(List): add documentation to the List widget docs(list): add documentation to the List widget Dec 7, 2023
@orhun orhun merged commit 3ec4e24 into ratatui:main Dec 7, 2023
32 of 33 checks passed
@Valentin271 Valentin271 deleted the docs/list branch December 7, 2023 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants