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

text wrap comments to completely fit within the preview pane #11

Open
rnag opened this issue Apr 4, 2022 · 0 comments
Open

text wrap comments to completely fit within the preview pane #11

rnag opened this issue Apr 4, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rnag
Copy link
Owner

rnag commented Apr 4, 2022

  • cargo-rx version:
  • Rust Compiler (rustc) version:
  • Operating System:

Description

Instead of displaying the example file contents directly in the preview pane, it'd be ideal to leverage a text wrapping library such as textwrap to wrap the doc comments -- and regular comments if feasible -- so that we can be sure that the comments completely fit within the preview pane, and are displayed as expected without any text cutting off near the end.

For example, note that comments in a line that are past a max width are hidden in the preview pane currently:
image

Related Issues

This issue goes with #12

What I Did

I just cd into my project folder and ran:

$ rx
@rnag rnag changed the title Text wrap comments so they can fit in the preview pane Text wrap comments to completely fit within the preview pane Apr 4, 2022
@rnag rnag added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Apr 4, 2022
@rnag rnag changed the title Text wrap comments to completely fit within the preview pane text wrap comments to completely fit within the preview pane Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant