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: improve scrollbar doc comment #329

Merged
merged 1 commit into from
Jul 17, 2023
Merged

Conversation

a-kenji
Copy link
Contributor

@a-kenji a-kenji commented Jul 17, 2023

I find the title is not really needed for the doc comment.

Alternative:

Rename tui-rs to ratatui in the title, but I find that this is not needed.

@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

Merging #329 (f988a7f) into main (df90982) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #329   +/-   ##
=======================================
  Coverage   85.05%   85.05%           
=======================================
  Files          40       40           
  Lines        8590     8590           
=======================================
  Hits         7306     7306           
  Misses       1284     1284           
Impacted Files Coverage Δ
src/widgets/scrollbar.rs 87.71% <ø> (ø)

@joshka
Copy link
Member

joshka commented Jul 17, 2023

Actually that highlights something for me. That title should show up in the one line description of the struct, but it doesn't because it shows up in the re-exports because the scrollbar module is public. For consistency it shouldn't actually be public, but that required moving the sets. PR for that incoming. There should still be a one line description of the struct though, so just drop the tui-rs part.

@a-kenji
Copy link
Contributor Author

a-kenji commented Jul 17, 2023

Good catch!

I changed the title to be in line with existing widget titles.
I found this made the first line in the body obsolete.

@joshka joshka enabled auto-merge July 17, 2023 11:48
@a-kenji a-kenji changed the title docs: remove scrollbar comment title docs: improve scrollbar doc comment Jul 17, 2023
@joshka
Copy link
Member

joshka commented Jul 17, 2023

Are you able to setup commit signing? https://docs.github.com/articles/about-gpg/

Verified

This commit was signed with the committer’s verified signature.
a-kenji kenji
auto-merge was automatically disabled July 17, 2023 11:51

Head branch was pushed to by a user without write access

@joshka joshka added this pull request to the merge queue Jul 17, 2023
@joshka
Copy link
Member

joshka commented Jul 17, 2023

Thanks :) Merged!

Merged via the queue into ratatui:main with commit c3f87f2 Jul 17, 2023
@a-kenji a-kenji deleted the fix/doc/comment branch July 17, 2023 12:06
@joshka joshka added this to the v0.23.0 milestone Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants