-
-
Notifications
You must be signed in to change notification settings - Fork 346
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
style(paragraph): add documentation for "scroll"'s "offset" #355
Conversation
Codecov Report
@@ Coverage Diff @@
## main #355 +/- ##
==========================================
+ Coverage 84.76% 86.13% +1.37%
==========================================
Files 40 40
Lines 8603 9239 +636
==========================================
+ Hits 7292 7958 +666
+ Misses 1311 1281 -30
|
Type aliases are not shown in rustdocs so I'm not sure if it would be useful to add them. I think only adding a comment to Let's also hear what other maintainers think. |
I think based on some discussions in discord and github we should add a bit more docs to the doc comment around this rather than just a single line comment. It should cover:
|
updated to have:
as for the other things, i dont know enough about it to write text for it (like how wrapping is decided, interacts with scroll or how scroll is clamped)
should this really be mentioned? |
LGTM - no problem with the other stuff. |
This PR adds some rustdoc documentation and type helper to clarify what the values in
Paragraph
'sscroll
arethe
type
s are useful because they are shown in rust-analyzer (though i can remove it if wanted)Why?
because before it was not clear in what order the values should be