docs(canvas): add documentation for x_bounds, y_bounds #35
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
mindoodoo
added
the
Type: Documentation
mindoodoo
reviewed
Feb 16, 2023
mindoodoo
suggested changes
Feb 28, 2023
src/widgets/canvas/mod.rs
Outdated
Comment on lines
426
to
445
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// # use tui::style::Color; | ||
| /// # use tui::widgets::{Block, Borders}; | ||
| /// # use tui::widgets::canvas::{Canvas, Map, MapResolution}; | ||
| /// let canvas = Canvas::default() | ||
| /// .block(Block::default().borders(Borders::ALL).title("World")) | ||
| /// .paint(|ctx| { | ||
| /// ctx.draw(&Map { | ||
| /// color: Color::White, | ||
| /// resolution: MapResolution::High, | ||
| /// }); | ||
| /// }) | ||
| /// .x_bounds([-180.0, 180.0]) | ||
| /// .y_bounds([-90.0, 90.0]); | ||
| /// ``` | ||
| /// | ||
| /// If you were to "zoom" to a certain part of the world you may want to choose different | ||
| /// bounds. |
There was a problem hiding this comment.
Maybe not really needed ? A bit wordy
src/widgets/canvas/mod.rs
Outdated
Comment on lines
394
to
413
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// # use tui::style::Color; | ||
| /// # use tui::widgets::{Block, Borders}; | ||
| /// # use tui::widgets::canvas::{Canvas, Map, MapResolution}; | ||
| /// let canvas = Canvas::default() | ||
| /// .block(Block::default().borders(Borders::ALL).title("World")) | ||
| /// .paint(|ctx| { | ||
| /// ctx.draw(&Map { | ||
| /// color: Color::White, | ||
| /// resolution: MapResolution::High, | ||
| /// }); | ||
| /// }) | ||
| /// .x_bounds([-180.0, 180.0]) | ||
| /// .y_bounds([-90.0, 90.0]); | ||
| /// ``` | ||
| /// | ||
| /// If you were to "zoom" to a certain part of the world you may want to choose different | ||
| /// bounds. |
There was a problem hiding this comment.
Maybe not really need ? A bit wordy.
sayanarijit
reviewed
Mar 3, 2023
There was a problem hiding this comment.
@mindoodoo @orhun Feel free to merge the suggested changes if you agree with it.
Co-authored-by: Arijit Basu <[email protected]>
orhun
changed the title
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.
Description
There is no description in docs for
Canvas::x_boundsandCanvas::y_bounds, but there is a question about that with response of the author. So this PR puts this response as documentation for the methods with some small corrections and formatting.Testing guidelines
This PR does not add any code, but all code fragments in documentation are valid & buildable.
Checklist