-
Notifications
You must be signed in to change notification settings - Fork 0
🐛 update formatting to support again multi-line descriptions #151
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
Conversation
- update tests once the relative imports are updated
🐛 Centering does not work for text after a blank line
|
@sayalaruano What was the rationale behind indenting the description? The first line is omitted. vuegen/src/vuegen/config_manager.py Lines 198 to 216 in c8ac5c9
So the basic example description is A general description of the report.
It should test all major components which are available
to be integrated into VueGen.
Check our tests folder for examples of report files used to generate actual reports.and will be translated to by that function (to be added to the A general description of the report.
It should test all major components which are available
to be integrated into VueGen.
Check our tests folder for examples of report files used to generate actual reports.I will remove the |
- less confusing handling of files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes formatting issues to properly support multi-line descriptions in HTML output. The changes update the string concatenation and formatting logic to preserve multi-line text content across both Streamlit and Quarto report formats.
- Updates HTML string formatting from concatenated strings to triple-quoted strings with proper indentation
- Removes line break replacement logic that was preventing multi-line descriptions from rendering correctly
- Adds multi-line content to test data to validate the formatting fix
Reviewed Changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/vuegen/streamlit_reportview.py |
Updates _format_text method to use triple-quoted strings and proper indentation for multi-line HTML content |
src/vuegen/quarto_reportview.py |
Removes unnecessary f-string formatting for report descriptions |
src/vuegen/config_manager.py |
Removes line break replacement logic in _read_description_file method |
docs/example_data/Basic_example_vuegen_demo_notebook/description.md |
Adds multi-line test content |
| Multiple test files | Updates generated test files to reflect the new formatting approach |
Uh oh!
There was an error while loading. Please reload this page.