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

doc: minor formatting and consistency fixes #2103

Merged
merged 1 commit into from
Jul 2, 2024
Merged

doc: minor formatting and consistency fixes #2103

merged 1 commit into from
Jul 2, 2024

Conversation

StenAL
Copy link
Contributor

@StenAL StenAL commented Jun 22, 2024

This patch includes some minor consistency fixes I noticed when reading the man page:

  • A few commands had extra blank lines before starting their description which was causing extra whitespace to be added to the description.
  • Some information relevant to commands was nested under example commands because of leading whitespace (mostly the information about -nevra commands).
  • Some example commands followed their description, while most other examples have the command first and then the description. This changes all examples to the latter for consistency.
  • Renamed the Examples header to Repoquery Examples similar to other example headers
  • Fixed typo in repoquery examples (ligttpd -> lighttpd)
  • Added parameter names to swap description

Also this updates the man page file name in the README (dnf.8 -> dnf4.8) as that's the actual file generated by make.

This patch includes some minor consistency fixes I noticed when reading
the man page:
- A few commands had extra blank lines before starting their description
  which was causing extra whitespace to be added to the description.
- Some information relevant to commands was nested under example
  commands because of leading whitespace (mostly the information about
  `-nevra` commands).
- Some example commands followed their description, while most other
  examples have the command first and then the description. This changes
  all examples to the latter for consistency.
- Renamed the `Examples` header to `Repoquery Examples` similar to other
  example headers
- Fixed typo in repoquery examples (ligttpd -> lighttpd)
- Added parameter names to `swap` description

Also this updates the man page file name in the README (dnf.8 -> dnf4.8)
@pkratoch pkratoch self-assigned this Jul 2, 2024
@pkratoch
Copy link
Contributor

pkratoch commented Jul 2, 2024

Thanks for the patch!

@pkratoch pkratoch merged commit b06dca1 into rpm-software-management:master Jul 2, 2024
8 of 9 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