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: fix scrollbar ascii illustrations and calendar doc paths #272

Merged
merged 3 commits into from
Jun 21, 2023

Conversation

SLASHLogin
Copy link
Contributor

This PR fixes scrollbar's documentation, which tried to showcase its elements. This requires for the text to be rendered exactly how it was written, which isn't the case for the cargo and other tools. Thus, it requires to be wrapped inside text blocks, which preserves text as is.
Secondly, there were problems with doc paths in calendar's documentation.
Finally, recently merged changes in block.rs were not formatted properly

@codecov
Copy link

codecov bot commented Jun 19, 2023

Codecov Report

Merging #272 (ca454a3) into main (a04b190) will not change coverage.
The diff coverage is n/a.

❗ Current head ca454a3 differs from pull request most recent head 27e59aa. Consider uploading reports for the commit 27e59aa to get more accurate results

@@           Coverage Diff           @@
##             main     #272   +/-   ##
=======================================
  Coverage   82.50%   82.50%           
=======================================
  Files          36       36           
  Lines        7301     7301           
=======================================
  Hits         6024     6024           
  Misses       1277     1277           
Impacted Files Coverage Δ
src/widgets/block.rs 83.29% <ø> (ø)
src/widgets/calendar.rs 82.30% <ø> (ø)
src/widgets/scrollbar.rs 87.71% <ø> (ø)

Copy link
Member

@mindoodoo mindoodoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch ! Thanks for the PR.

@mindoodoo mindoodoo changed the title fix(docs): Fix recently added widget's documentation docs: fix scrollbar ascii illustrations and calendar doc paths Jun 19, 2023
@mindoodoo mindoodoo added the Type: Documentation Improvements or additions to documentation label Jun 19, 2023
Copy link
Collaborator

@kdheepak kdheepak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching that! Is it possible to have a doc preview on each PR?

@SLASHLogin
Copy link
Contributor Author

Thanks for catching that! Is it possible to have a doc preview on each PR?

I'm not aware of any way to do that. Personally, I just use cargo-watch when creating PR and/or editing documentation. But when reviewing, you'd have to download the PR and run it locally.

@mindoodoo
Copy link
Member

Didn't know about cargo-watch, looks awesome ! Definitely adding it to my workflow.

@orhun orhun enabled auto-merge June 20, 2023 21:22
auto-merge was automatically disabled June 21, 2023 09:01

Head branch was pushed to by a user without write access

@SLASHLogin
Copy link
Contributor Author

Sorry, I had to sign the commits for this to be merged. It would be nice to include that information in the CONTRIBUTING.md

@orhun orhun added this pull request to the merge queue Jun 21, 2023
Merged via the queue into ratatui:main with commit b808305 Jun 21, 2023
@SLASHLogin SLASHLogin deleted the hotfix/new-widgets-docs branch June 21, 2023 12:22
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.

5 participants