You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by jl...@apache.org on 2018/11/19 18:56:59 UTC
[2/4] tomee git commit: "Fixing some grammar"
"Fixing some grammar"
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/a82fdd5d
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/a82fdd5d
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/a82fdd5d
Branch: refs/heads/master
Commit: a82fdd5d10f4d0813cfdcdccc363ce6cf292b292
Parents: ae7607a
Author: Richard Monson-Haefel <Ri...@Uncommon-Design.com>
Authored: Mon Nov 19 12:29:50 2018 -0600
Committer: Richard Monson-Haefel <Ri...@Uncommon-Design.com>
Committed: Mon Nov 19 12:29:50 2018 -0600
----------------------------------------------------------------------
examples/access-timeout-meta/README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/a82fdd5d/examples/access-timeout-meta/README.md
----------------------------------------------------------------------
diff --git a/examples/access-timeout-meta/README.md b/examples/access-timeout-meta/README.md
index 716efb6..59bdd47 100644
--- a/examples/access-timeout-meta/README.md
+++ b/examples/access-timeout-meta/README.md
@@ -3,7 +3,7 @@ Title: @AccessTimeout the Meta-Annotation Way
Any annotation that takes parameters can benefit from meta-annotations. Here we see how `@AccessTimeout` can be far more understandable and manageable through meta-annotations.
We'll use the [access-timeout](../access-timeout/README.html) example as our use-case.
-The value of the parameters supplied to `@AccessTimeout` have a dramatic affect on how what that annotation actually does. Moreover, `@AccessTimeout` has one of those designs
+The value of the parameters supplied to `@AccessTimeout` have a dramatic affect on what that annotation actually does. Moreover, `@AccessTimeout` has one of those designs
where `-1` and `0` have signifcantly different meanings. One means "wait forever", the other means "never wait". Only a lucky few can remember which is which on a daily basis.
For the rest of us it is a constant source of bugs.
@@ -114,7 +114,7 @@ The simplest approach is to name your meta-annotations after the **configuration
to clearly reflect the contents of each meta-annotation (`@AccessTimeout(-1)` and `@AccessTimeout(0)` respectively).
The **cons** of this approach is that should you want to change the configuration of the application by only changing the meta-annotations -- this is one of the potential benefits
-of meta-annotations. Certainly, the `@AwaitNever` meta-annotation can have no other value than `0` if it is to live up to its name.
+of meta-annotations -- but this may change the meaning of the annotation. Certainly, the `@AwaitNever` meta-annotation can have no other value than `0` if it is to live up to its name.
## Operation names <small>describing the code</small>
@@ -122,7 +122,7 @@ The alternate approach is to name your meta-annotations after the **operations**
`@OrderCheckTimeout` or `@TwitterUpdateTimeout`. These names are configuration-change-proof. They would not change if the configuration changes and in fact they can facilitate
finder-grained control over the configuration of an application.
-The **cons** are of course it is requires far more deliberation and consideration, not to mention more annotations. Your skills as an architect, designer and ability to think as
+The **cons** of this approach is that requires far more deliberation and consideration, not to mention more annotations. Your skills as an architect, designer and ability to think as
a administrator will be challenged. You must be good at wearing your dev-opts hat.
## Pragmatism <small>best of both worlds</small>