diff --git a/DEV-GUIDELINES.md b/DEV-GUIDELINES.md index 877c9e8390958..c76106ddbcdc6 100644 --- a/DEV-GUIDELINES.md +++ b/DEV-GUIDELINES.md @@ -445,7 +445,7 @@ int anSizes[] = new int[MAX_COUNT]; 5. For complex (non-intrinsic) Java types, the intent prefix should reflect a core use of the reference in a shortest but recognizable manner. -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. +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. Example variable declarations: ```java @@ -617,7 +617,7 @@ Example: Unacceptable JavaDoc Style 6. Always provide `@param`, `@return`, `@throws`, `@since` declarations in that order. -7. There must be a blank comment line between each JavaDoc tag (`@param`, `@return` et al) declaration except between `@author` and `@since`. +7. There must be a blank comment line between each JavaDoc tag (`@param`, `@return` et al.) declaration except between `@author` and `@since`. 8. Align `@param` declaration descriptions. @@ -752,7 +752,7 @@ Consumer charPrinter = s -> } ``` -3. The parentheses should be used around lambda arguments only if required by the Java compiler (ie. when there are two or more arguments). +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). 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. @@ -813,8 +813,8 @@ The annotation is recommended when: The annotation is not recommended when: -* It is obvious that a method is being overridden (for example toString, equals, etc) -* Implementing common interfaces (for example `Map.put`, `Map.get`, etc) +* It is obvious that a method is being overridden (for example toString, equals, etc.) +* Implementing common interfaces (for example `Map.put`, `Map.get`, etc.) * A class that is implementing a single interface * Anonymous classes @@ -879,7 +879,7 @@ TDE is an entire development environment, IDE + ([bootstrapping](https://en.wiki ## IDE Keyboard shortcuts -| Key stroke | Descritpion | +| Key stroke | Description | |------------|-------------| |Ctrl-A, Command-A|Select all.| |Ctrl-B, Command-B|Go to a method declaration. works only within a scope of a single component.| diff --git a/README.md b/README.md index 6ea820105b293..bd221c9d2b4ff 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The product is used at scale, for both compute and raw storage, in a vast array industries such as critical financial trading systems, high performance telecommunication products and eCommerce applications. -Typically these deployments do not tolerate any downtime and Coherence is chosen due to its +Typically, these deployments do not tolerate any downtime and Coherence is chosen due to its novel features in death detection, application data evolvability, and the robust, battle-hardened core of the product that enables it to be seamlessly deployed and adapted within any ecosystem. @@ -84,7 +84,7 @@ evict, shun, or in some cases, voluntarily depart the cluster when deemed necess As members join and leave the cluster, other Coherence services are notified, thus enabling those services to react accordingly. -> Note: This part of the Coherence product has been in production for more that 10 years, +> Note: This part of the Coherence product has been in production for more than 10 years, > being the subject of some extensive and imaginative testing. While this feature has > been discussed here, it certainly is not something that customers, generally, > 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 (leverages persistence feature). * **Lossy redundancy** - Ability to reduce the redundancy guarantee by making backups and/or persistence asynchronous from a client perspective. -* **Single Mangement View** - Provides insight into the cluster with a single +* **Single Management View** - Provides insight into the cluster with a single JMX server that provides a view of all members of the cluster. * **Management over REST** - All JMX data and operations can be performed over REST, including cluster wide thread dumps and heapdumps. @@ -173,7 +173,7 @@ You must have the following installed and available on your PATH. 1. Java - JDK 17 or higher 2. Maven - 3.8.5 or higher - 3. Cohrence CLI Installed (see below) + 3. Coherence CLI Installed (see below) The following example shows you how to quickly get started with Coherence using the [Coherence CLI](https://github.com/oracle/coherence-cli) to create a 3 node Coherence cluster scoped to you local machine.