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.

Sign up for GitHub

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

Jump to bottom

Add better docs for how to use block in block.rs #914

Closed
joshka opened this issue Feb 4, 2024 · 0 comments
Closed

Add better docs for how to use block in block.rs #914

joshka opened this issue Feb 4, 2024 · 0 comments
Labels
Effort: Good First Issue Good for newcomers without much Rust or Ratatui experiance. Apply only if willing to help implement Type: Enhancement New feature or request

Comments

@joshka
Copy link
Member

joshka commented Feb 4, 2024

Problem

Similar to ratatui/ratatui-website#424 which asks this to be added to the website the blocks docs https://docs.rs/ratatui/latest/ratatui/widgets/block/struct.Block.html could add some more details about using it to surround widgets by passing it as a parameter.

The main doc comment needs to have several summary list similar to the other newer widgets that shows the setter methods that are used to configure the widget, the constructors, and those that are used after the widget is created (e.g. inner()), pointing to the appropriate methods lower.

Solution

Update the docs

Alternatives

Additional context
@joshka joshka added Type: Enhancement New feature or request Effort: Good First Issue Good for newcomers without much Rust or Ratatui experiance. Apply only if willing to help implement labels Feb 4, 2024
leohscl added a commit to leohscl/ratatui that referenced this issue Jun 27, 2024
@leohscl
docs(block.rs): update block documentation
15e8abb 
Update block documentation with constructor methods and setter methods in the main doc comment
Added an example for using it to surround widgets

Issue: ratatui#914
@leohscl leohscl mentioned this issue Jun 27, 2024
Merged
@joshka joshka closed this as completed in 55e0880 Jun 27, 2024
joshka pushed a commit to erak/ratatui that referenced this issue Oct 14, 2024
@leohscl @joshka
docs(block): update block documentation (ratatui#1206)
859c02f 
Update block documentation with constructor methods and setter methods
in the main doc comment Added an example for using it to surround
widgets

Fixes: ratatui#914
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Effort: Good First Issue Good for newcomers without much Rust or Ratatui experiance. Apply only if willing to help implement Type: Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@joshka