Skip to content

Commit 53210f3

Browse files
Jay Bryantjxblum
authored andcommitted
Edit the intro to the Apache Geode API Extensions chapter in the reference documentation.
Mostly fixed small things and a couple of sentences that were long enough to be hard to parse. Resolves gh-106.
1 parent afdc4b6 commit 53210f3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

spring-geode-docs/src/docs/asciidoc/_includes/geode-api-ext.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@
77

88
The Spring Boot for {geode-name} (SBDG) project includes the `org.springframework.geode:apache-geode-extensions` module
99
to make use of the {geode-name} {apache-geode-javadoc}[APIs] in a Spring and non-Spring application context more
10-
effective. While this module is relatively new, it contains several, necessary API extensions already.
10+
effective. While this module is relatively new, it already contains several necessary API extensions.
1111

12-
{geode-name} {apache-geode-javadoc}[APIs] are quite complex and difficult to use properly, especially without prior
13-
knowledge or experience to do so. Users very often get things wrong and is the main reason why Spring's APIs
14-
for {geode-name} are invaluable; they lead users to do the right thing from the start, first and foremost.
12+
{geode-name} {apache-geode-javadoc}[APIs] can be complex and difficult to use properly, especially without prior
13+
knowledge or experience. Users often get things wrong, which is why Spring's APIs
14+
for {geode-name} are invaluable. They lead users to do the right thing from the start, first and foremost.
1515

16-
However, this module does not simply exist only to help users use {geode-name}'s APIs more effectively. In fact, with
17-
Spring's abstractions, it should not be necessary to use {geode-name} APIs at all, e.g. like when using the Spring Cache
16+
However, this module does not exist only to help users use {geode-name}'s APIs more effectively. In fact, with
17+
Spring's abstractions, it should not be necessary to use {geode-name} APIs at all -- for example, when using the Spring Cache
1818
Abstraction for caching or the Spring Data Repository abstraction for DAO development. This module is necessary
19-
to enable Spring for {geode-name} to overcome and adapt to the limitations the API in a Spring and application context
20-
in order to do what Spring for {geode-name} needs to do that makes the experience familiar to Spring users.
19+
to enable Spring for {geode-name} to overcome and adapt to the limitations of the API in a Spring application context.
20+
That lets Spring for {geode-name} offer an experience familiar to Spring users.
2121

22-
In general, Spring shields users from design problems as well as changes in 3rd party library APIs, which could
22+
In general, Spring shields users from design problems as well as changes in third party library APIs that could
2323
adversely affect your Spring applications when integrating with these libraries. Spring's APIs provide a layer of
24-
indirection along with enhanced capabilities (e.g. Exception translation).
24+
indirection along with enhanced capabilities (such as exception translation).
2525

2626
TIP: Spring Data for {geode-name} (SDG) also {spring-data-geode-docs-html}/#apis[offers] some relief when using
2727
{geode-name}'s APIs.

0 commit comments

Comments
 (0)