Skip to content

docs: fix grammar and spelling #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −10
Open

docs: fix grammar and spelling #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions DEV-GUIDELINES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -752,7 +752,7 @@ Consumer<String> 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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.|
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down