Skip to content

Commit fad1631

Browse files
committed
Reword documentation sections
1 parent 141266c commit fad1631

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

src/docs/asciidoc/overview.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,19 @@ The next section provides more details about the evolution of programming interf
9191
[[stability-of-programming-interfaces]]
9292
== Stability of Programming Interfaces
9393

94-
The RabbitMQ Stream Java Client is in active development but its programming interfaces will remain as stable as possible. There is no guarantee though that they will remain completely stable, at least until it reaches version 1.0.0.
94+
The RabbitMQ Stream Java Client is in active development but its programming interfaces will remain as stable as possible.
95+
There is no guarantee though that they will remain completely stable, at least until it reaches version 1.0.0.
9596

9697
The client contains 2 sets of programming interfaces whose stability are of interest for application developers:
9798

98-
* Application Programming Interfaces (API): those are the ones used to write application logic. They include the interfaces and classes in the `com.rabbitmq.stream` package (e.g. `Producer`, `Consumer`, `Message`). These API constitute the main programming model of the client and will be kept as stable as possible.
99-
* Service Provider Interfaces (SPI): those are interfaces to implement mainly technical behavior in the client. They are not meant to be used to implement application logic. Application developers may have to refer to them in the configuration phase and if they want to custom some internal behavior in the client. SPI include interfaces and classes in the `com.rabbitmq.stream.codec`, `com.rabbitmq.stream.compression`, `com.rabbitmq.stream.metrics` packages, among others. _These SPI are susceptible to change, but this should not impact the majority of applications_, as the changes would typically stay intern to the client.
99+
* Application Programming Interfaces (API): those are the ones used to write application logic.
100+
They include the interfaces and classes in the `com.rabbitmq.stream` package (e.g. `Producer`, `Consumer`, `Message`).
101+
These API constitute the main programming model of the client and will be kept as stable as possible.
102+
* Service Provider Interfaces (SPI): those are interfaces to implement mainly technical behavior in the client.
103+
They are not meant to be used to implement application logic.
104+
Application developers may have to refer to them in the configuration phase and if they want to customize some internal behavior of the client.
105+
SPI include interfaces and classes in the `com.rabbitmq.stream.codec`, `com.rabbitmq.stream.compression`, `com.rabbitmq.stream.metrics` packages, among others.
106+
_These SPI are susceptible to change, but this should have no impact on most applications_, as the changes are likely to be limited to the client internals.
100107

101108
== Pre-requisites
102109

0 commit comments

Comments
 (0)