Skip to content

Commit 0439aed

Browse files
committed
Integration of changes from PR #139 'docs: fix grammar and spelling' by jbamptom 'at' gmail.com
[git-p4: depot-paths = "//dev/coherence-ce/main/": change = 116142]
1 parent 62c865f commit 0439aed

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

DEV-GUIDELINES.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ int anSizes[] = new int[MAX_COUNT];
445445

446446
5. For complex (non-intrinsic) Java types, the intent prefix should reflect a core use of the reference in a shortest but recognizable manner.
447447

448-
6. Where a variable is used only once, abbreviates may not be required. However abbreviations are encouraged when a type is used more than once.
448+
6. Where a variable is used only once, abbreviates may not be required. However, abbreviations are encouraged when a type is used more than once.
449449

450450
Example variable declarations:
451451
```java
@@ -617,7 +617,7 @@ Example: Unacceptable JavaDoc Style
617617
618618
6. Always provide `@param`, `@return`, `@throws`, `@since` declarations in that order.
619619
620-
7. There must be a blank comment line between each JavaDoc tag (`@param`, `@return` et al) declaration except between `@author` and `@since`.
620+
7. There must be a blank comment line between each JavaDoc tag (`@param`, `@return` et al.) declaration except between `@author` and `@since`.
621621
622622
8. Align `@param` declaration descriptions.
623623
@@ -752,7 +752,7 @@ Consumer<String> charPrinter = s ->
752752
}
753753
```
754754
755-
3. The parentheses should be used around lambda arguments only if required by the Java compiler (ie. when there are two or more arguments).
755+
3. The parentheses should be used around lambda arguments only if required by the Java compiler (i.e. when there are two or more arguments).
756756
757757
4. The nesting of lambdas should be avoided, not only because it creates a [Pyramid of Doom](https://en.wikipedia.org/wiki/Pyramid_of_doom_(programming)), but more importantly because it makes inner lambdas non-remotable, thus breaking the support for remoting of outer lambdas as well.
758758
@@ -813,8 +813,8 @@ The annotation is recommended when:
813813

814814
The annotation is not recommended when:
815815

816-
* It is obvious that a method is being overridden (for example toString, equals, etc)
817-
* Implementing common interfaces (for example `Map.put`, `Map.get`, etc)
816+
* It is obvious that a method is being overridden (for example toString, equals, etc.)
817+
* Implementing common interfaces (for example `Map.put`, `Map.get`, etc.)
818818
* A class that is implementing a single interface
819819
* Anonymous classes
820820

@@ -879,7 +879,7 @@ TDE is an entire development environment, IDE + ([bootstrapping](https://en.wiki
879879

880880
## IDE Keyboard shortcuts
881881

882-
| Key stroke | Descritpion |
882+
| Key stroke | Description |
883883
|------------|-------------|
884884
|Ctrl-A, Command-A|Select all.|
885885
|Ctrl-B, Command-B|Go to a method declaration. works only within a scope of a single component.|

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The product is used at scale, for both compute and raw storage, in a vast array
3838
industries such as critical financial trading systems, high performance telecommunication
3939
products and eCommerce applications.
4040

41-
Typically these deployments do not tolerate any downtime and Coherence is chosen due to its
41+
Typically, these deployments do not tolerate any downtime and Coherence is chosen due to its
4242
novel features in death detection, application data evolvability, and the robust,
4343
battle-hardened core of the product that enables it to be seamlessly deployed and
4444
adapted within any ecosystem.
@@ -84,7 +84,7 @@ evict, shun, or in some cases, voluntarily depart the cluster when deemed necess
8484
As members join and leave the cluster, other Coherence services are notified,
8585
thus enabling those services to react accordingly.
8686

87-
> Note: This part of the Coherence product has been in production for more that 10 years,
87+
> Note: This part of the Coherence product has been in production for more than 10 years,
8888
> being the subject of some extensive and imaginative testing. While this feature has
8989
> been discussed here, it certainly is not something that customers, generally,
9090
> interact with directly, but is important to be aware of.
@@ -156,7 +156,7 @@ snapshot of cluster state, and recover snapshot in this or a different cluster
156156
(leverages persistence feature).
157157
* **Lossy redundancy** - Ability to reduce the redundancy guarantee by making backups
158158
and/or persistence asynchronous from a client perspective.
159-
* **Single Mangement View** - Provides insight into the cluster with a single
159+
* **Single Management View** - Provides insight into the cluster with a single
160160
JMX server that provides a view of all members of the cluster.
161161
* **Management over REST** - All JMX data and operations can be performed over REST,
162162
including cluster wide thread dumps and heapdumps.
@@ -173,7 +173,7 @@ You must have the following installed and available on your PATH.
173173

174174
1. Java - JDK 17 or higher
175175
2. Maven - 3.8.5 or higher
176-
3. Cohrence CLI Installed (see below)
176+
3. Coherence CLI Installed (see below)
177177

178178
The following example shows you how to quickly get started with Coherence using the
179179
[Coherence CLI](https://github.com/oracle/coherence-cli) to create a 3 node Coherence cluster scoped to you local machine.

0 commit comments

Comments
 (0)