Uploaded image for project: 'AMQ Documentation'
  1. AMQ Documentation
  2. AMQDOC-2643

Information about wildcard syntax in 8.12 Configuring Address Settings doesn't follow IBM Style Guidelines; improper use of call-outs

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Obsolete
    • Icon: Minor Minor
    • None
    • 7.0
    • Broker DOC

      I think that I peer-reviewed this section some time ago and unfortunately, must have been lax because I see additional issues. Argh.

      IBM Style Guide - Chapter 2, pages 37-39:
      "Do not refer to an individual punctuation mark or special character by its symbol alone. Use the name alone or the name followed by the symbols in parenthesis."

      The procedure in "Configuring Wildcard Syntax" is also not quite right, I think. There should be steps to the task instead of a single bullet. And the call-outs should not be used as "steps" in the procedure. The call-out should be descriptive. We may need to revisit this with the team - I might need a sanity check.

            jbyrne@redhat.com John Byrne
            sjay@redhat.com Susan Jay
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: