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

Fixed a Minor correction in ASCIIDOC Markup #476

Conversation

dubewarsagar
Copy link
Contributor

There was a minor correction required in the QETH.adoc file about incorrect markup.

@dubewarsagar
Copy link
Contributor Author

dubewarsagar commented May 29, 2024

@snarayan-redhat Can you review this or tag any of the maintainers to review this? Thanks

@snarayan-redhat
Copy link

@redhat-documentation/ccs-style-council Can you PTAL this minor fix?

@@ -44,7 +44,7 @@

[[qeth]]
==== image:images/yes.png[yes] qeth (adjective)
*Description*: Messages with a prefix `qeth` are issued by the `qeth` device driver. The `qet`h device driver supports a multitude of network connections, for example, connections through Open Systems Adapters (OSA), HiperSockets™, guest LANs, and virtual switches.
*Description*: Messages with a prefix `qeth` are issued by the `qeth` device driver. The `qeth` device driver supports a multitude of network connections, for example, connections through Open Systems Adapters (OSA), HiperSockets™, guest LANs, and virtual switches.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*Description*: Messages with a prefix `qeth` are issued by the `qeth` device driver. The `qeth` device driver supports a multitude of network connections, for example, connections through Open Systems Adapters (OSA), HiperSockets™, guest LANs, and virtual switches.
*Description*: Messages with a prefix `qeth` are issued by the `qeth` device driver. The `qeth` device driver supports a multitude of network connections, such as connections through Open Systems Adapters (OSA), HiperSockets™, guest LANs, and virtual switches.

This removed the non-restrictive clause (for example) that comes between the connections-connections clauses.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per ISG (https://www.ibm.com/docs/en/ibm-style?topic=format-examples#inline-examples), this "for example" is used properly.

Either way, this is just fixing a typo, so I think it's fine to merge this change as is and not worry about other fixes in the existing text.

Copy link
Collaborator

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for submitting this fix!

@bergerhoffer bergerhoffer added the General update General updates to the guide or repo label May 30, 2024
Copy link
Contributor

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@bredamc bredamc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bredamc bredamc merged commit fe7631c into redhat-documentation:main May 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
General update General updates to the guide or repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants