🐛 update formatting to support again multi-line descriptions#151
Merged
Conversation
- update tests once the relative imports are updated
Closed
3 tasks
🐛 Centering does not work for text after a blank line
Collaborator
Author
|
@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.
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 |
sayalaruano
approved these changes
Jul 18, 2025
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.