jakartaee / jakartaee/messaging

Section 8.7 of the JMS 2.0 spec has a malformed sentence

Open
#137 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

jms21-forreview-minor Priority: Minor Type: Improvement
Dominant language
Java
Stars
49
Forks
34
PR merge metrics
No merged PRs in 30d

Description

There is a confusing/malformed sentence in section 8.7 of the JMS 2.0 spec (also present in section 4.5.2 of 1.1 spec). The sentence is "Well behaved listeners should catch
such exceptions and attempt to divert messages causing them to some form
of application-specific 'unprocessable message' destination."

Is this trying to say ".. and attempt to divert messages to some form of application-specific ...
? In other words I feel like the words "causing them" should be removed from this sentence. In any case, it needs to be reworded somehow to make the meaning clear, in my opinion.

=== Larger quote:

8.7\. Receiving messages asynchronously
...

It is possible for a listener to throw a RuntimeException; however, this is
considered a client programming error. Well behaved listeners should catch
such exceptions and attempt to divert messages causing them to some form
of application-specific 'unprocessable message' destination.

Thanks!
John Lindwall
#### Environment
N/A
#### Affected Versions
[1.1, 2.0]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading section 8.7 of the JMS 2.0 specification and the corresponding section 4.5.2 of the 1.1 specification, focusing on the quoted sentence and its surrounding context. Update the wording so the intended relationship between exceptions and diverting messages is unambiguous in both versions, then verify that the revised sentence preserves the specification's meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.