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: add backend docs #213

Merged
merged 1 commit into from
Jun 2, 2023
Merged

docs: add backend docs #213

merged 1 commit into from
Jun 2, 2023

Conversation

joshka
Copy link
Member

@joshka joshka commented Jun 2, 2023

No description provided.

@codecov
Copy link

codecov bot commented Jun 2, 2023

Codecov Report

Merging #213 (fa169f3) into main (509d185) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #213   +/-   ##
=======================================
  Coverage   81.66%   81.66%           
=======================================
  Files          34       34           
  Lines        6572     6572           
=======================================
  Hits         5367     5367           
  Misses       1205     1205           
Impacted Files Coverage Δ
src/backend/crossterm.rs 0.00% <ø> (ø)
src/backend/mod.rs 33.33% <ø> (ø)
src/backend/termion.rs 28.04% <ø> (ø)
src/backend/termwiz.rs 0.00% <ø> (ø)
src/backend/test.rs 43.63% <ø> (ø)

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.

Do we really need the doc comments on the Backend trait methods implemented by the different backends ? My understanding is that doc comments on the methods defined in the trait definition would propagate to the traits implementation unless overriden. After skimming through them real quick it seems that for the most part they are pretty much the same as the doc comments on the trait definition.

Lmk what you think, otherwise this was greatly needed, thanks for the PR !

src/backend/termwiz.rs Outdated Show resolved Hide resolved
@mindoodoo mindoodoo added the documentation Improvements or additions to documentation label Jun 2, 2023
@joshka
Copy link
Member Author

joshka commented Jun 2, 2023

My understanding is that doc comments on the methods defined in the trait definition would propagate to the traits implementation unless overriden.

Yep - you're right, will remove the unnecessary text.

@joshka
Copy link
Member Author

joshka commented Jun 2, 2023

I really should have checked that output more thoroughly - update incoming

@joshka joshka marked this pull request as draft June 2, 2023 13:37
@joshka joshka marked this pull request as ready for review June 2, 2023 14:23
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.

LGTM

@orhun orhun merged commit 5243aa0 into ratatui-org:main Jun 2, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants