Add code examples to the docs of TextBox #2284
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for your effort! I haven't looked at the substance of this PR yet, but please do the following:
|
|
@xStrom thanks for helping me! I think I did it all good with the change log, let me know if there is more to add or if I put something in an incorrect place! |
jneem
reviewed
Nov 29, 2022
CHANGELOG.md
Outdated
| @@ -150,6 +150,7 @@ You can find its changes [documented below](#070---2021-01-01). | |||
| - Update docs of `RawLabel`: does not require `ArcStr`([#1886] by [@Maan2003]) | |||
| - Fix `Controller` links for `Click` ([#2158] by [@yrns]) | |||
| - Delete inaccurate line for `KeyEvent` ([#2247] by [@amtep]) | |||
| - Added examples in `TextBox` ([#2284] by [@ThomasMcAndrew]) | |||
There was a problem hiding this comment.
I'm actually not sure if github markdown's links are case sensitive. But probably "andrew" is better just to be safe...
There was a problem hiding this comment.
@jneem Good catch, Thanks!
jneem
approved these changes
Nov 30, 2022
xStrom
reviewed
Nov 30, 2022
druid/src/widget/textbox.rs
Outdated
| /// | ||
| /// //will wrap for each line | ||
| /// let wrap_multi_line_text_box = TextBox::multiline() | ||
| /// .with_line_wrapping(true) // this is default can be removed for the same result |
There was a problem hiding this comment.
Let's add either a comma or and after the word default
xStrom
approved these changes
Dec 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey all,
I am new to Druid and fairly new to rust in general but I like this UI framework the best. I wanted some documentation so I figured I could just write it.
I can do it for all of them but I wanted to get one done and get feedback on how you want the documentation to look.
I think examples are the most helpful for myself so I focused on that the most.
Please give feedback I want to make the documentation best that it can be and I am new-ish to writing documentation for others, so critiques are helpful.