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

Fix the formatting of the monitor section in the README #68

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

yotka2
Copy link
Contributor

@yotka2 yotka2 commented Jul 9, 2024

The monitor section has some formatting errors, such as the indentation of all lines starting with the expr line, or the lack of newline before "The following options are available".

For reference, you can check hilda_client.py, where a similar section is formatted correctly.

@yotka2
Copy link
Contributor Author

yotka2 commented Jul 9, 2024

Now that I look at it, seems like there are other sections in the README that have similar issues (such as po and "Can also run big chunks of native code"). The monitor section is the one that confused me initially, so I focused on that.

@doronz88
Copy link
Owner

doronz88 commented Jul 9, 2024

I get why you are adding an indent in the first line, but why for the rest are you un-indenting?
They are all options for the same subcommand

@yotka2
Copy link
Contributor Author

yotka2 commented Jul 9, 2024

You mean the lines after the one starting with expr?
I unintended them because they're subcommands under monitor, but not under regs - see difference between current README and hilda_client.py (under the monitor function)

@doronz88 doronz88 merged commit 2f379b9 into doronz88:main Jul 9, 2024
@doronz88
Copy link
Owner

doronz88 commented Jul 9, 2024

Oh thanks! now I saw that

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