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

docs: add new line after host/vm/summary table #1838

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

sunya-ch
Copy link
Collaborator

@sunya-ch sunya-ch commented Nov 6, 2024

Before:

Screenshot 2024-11-06 at 18 12 19

After add a line:

Screenshot 2024-11-06 at 18 11 26

Signed-off-by: Sunyanan Choochotkaew [email protected]

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🤖 SeineSailor

Here is a concise summary of the pull request changes:

Summary: This pull request enhances the readability of the markdown report generated by the code by adding a new line after the host/VM summary table. The key modifications include introducing a new new_line() method to the MD class, which writes a newline to the output, and calling this method in the write_md_report() function after adding host and VM machine specs.

Impact: These changes do not affect the external interface or behavior of the code, and the signatures of exported functions and global data structures remain unchanged.

Observation: The addition of a newline character improves the report's readability, making it easier to consume and understand. However, it would be beneficial to consider adding a configuration option or parameter to control the formatting of the report, allowing users to customize the output according to their preferences.

@sunya-ch sunya-ch requested a review from sthaha November 6, 2024 09:14
@sunya-ch sunya-ch changed the title doc: add new line after host/vm/summary table docs: add new line after host/vm/summary table Nov 6, 2024
@sthaha sthaha merged commit 25bbaed into sustainable-computing-io:main Nov 6, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants