-
-
Notifications
You must be signed in to change notification settings - Fork 499
doc: update rz-asm manual with formatting improvements and environment variables #5698
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
base: dev
Are you sure you want to change the base?
Conversation
1597d92 to
175ec3f
Compare
175ec3f to
2dfdb16
Compare
|
Please add a linter job in the CI. Otherwise it is hard to verify that the changes work. |
Rot127
left a comment
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.
This is not how you would test it.
In general we do not accept vibe coded contributions.
Which your PR and commits here very much look like.
Please see our CONTRIBUTING.md for requirements for new contributors.
The testing requirement is in your case, that you need to add a CI job to test the mandoc warnings.
Your checklist for this pull request
RZ_APIfunction and struct this PR changes.RZ_API).Detailed description
This PR improves the
rz-asm.1manpage by fixing formatting inconsistencies and cleaning up the environment variables section.Changes:
\n"and stray characters fromRZ_DEBUGandRZ_NOPLUGINSdescriptions..Bl -tagand.It Evmacros for correct terminal rendering.DIRECTIVES) to standard uppercase.AI Disclosure: Used Gemini to assist with correct mdoc/roff macro syntax for the environment section.
Test plan
I verified the changes locally by rendering the manpage in the terminal: