Skip to content

Commit 8941e28

Browse files
quaffsbrannen
authored andcommitted
Replace 'e.g.' with 'for example' in documentation and comments
Closes gh-33515
1 parent e55fe90 commit 8941e28

File tree

722 files changed

+1290
-1290
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

722 files changed

+1290
-1290
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ multiple edits or corrections of the same logical change. See
8686
for an overview of streamlining the commit history.
8787

8888
1. Format commit messages using 55 characters for the subject line, 72 characters per line
89-
for the description, followed by the issue fixed, e.g. `Closes gh-22276`. See the
89+
for the description, followed by the issue fixed, for example, `Closes gh-22276`. See the
9090
[Commit Guidelines section of Pro Git](https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines)
9191
for best practices around commit messages, and use `git log` to see some examples.
9292

framework-docs/modules/ROOT/pages/core/aop/ataspectj/introductions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can make an introduction by using the `@DeclareParents` annotation. This ann
99
is used to declare that matching types have a new parent (hence the name). For example,
1010
given an interface named `UsageTracked` and an implementation of that interface named
1111
`DefaultUsageTracked`, the following aspect declares that all implementors of service
12-
interfaces also implement the `UsageTracked` interface (e.g. for statistics via JMX):
12+
interfaces also implement the `UsageTracked` interface (for example, for statistics via JMX):
1313

1414
[tabs]
1515
======

framework-docs/modules/ROOT/pages/core/aop/introduction-defn.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ with less potential for errors. For example, you do not need to invoke the `proc
6565
method on the `JoinPoint` used for around advice, and, hence, you cannot fail to invoke it.
6666

6767
All advice parameters are statically typed so that you work with advice parameters of
68-
the appropriate type (e.g. the type of the return value from a method execution) rather
68+
the appropriate type (for example, the type of the return value from a method execution) rather
6969
than `Object` arrays.
7070

7171
The concept of join points matched by pointcuts is the key to AOP, which distinguishes

framework-docs/modules/ROOT/pages/core/beans/annotation-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ can be found in the xref:core/beans/standard-annotations.adoc[relevant section].
2020
[NOTE]
2121
====
2222
Annotation injection is performed before external property injection. Thus, external
23-
configuration (e.g. XML-specified bean properties) effectively overrides the annotations
23+
configuration (for example, XML-specified bean properties) effectively overrides the annotations
2424
for properties when wired through mixed approaches.
2525
====
2626

framework-docs/modules/ROOT/pages/core/beans/context-introduction.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ You can register as many event listeners as you wish, but note that, by default,
484484
This means that the `publishEvent()` method blocks until all listeners have finished processing the event.
485485
One advantage of this synchronous and single-threaded approach is that, when a listener receives an event,
486486
it operates inside the transaction context of the publisher if a transaction context is available.
487-
If another strategy for event publication becomes necessary, e.g. asynchronous event processing by default,
487+
If another strategy for event publication becomes necessary, for example, asynchronous event processing by default,
488488
see the javadoc for Spring's {spring-framework-api}/context/event/ApplicationEventMulticaster.html[`ApplicationEventMulticaster`] interface
489489
and {spring-framework-api}/context/event/SimpleApplicationEventMulticaster.html[`SimpleApplicationEventMulticaster`] implementation
490490
for configuration options which can be applied to a custom "applicationEventMulticaster" bean definition.
@@ -864,7 +864,7 @@ Finally, as with classic `ApplicationListener` implementations, the actual multi
864864
happens via a context-wide `ApplicationEventMulticaster` at runtime. By default, this is a
865865
`SimpleApplicationEventMulticaster` with synchronous event publication in the caller thread.
866866
This can be replaced/customized through an "applicationEventMulticaster" bean definition,
867-
e.g. for processing all events asynchronously and/or for handling listener exceptions:
867+
for example, for processing all events asynchronously and/or for handling listener exceptions:
868868

869869
[source,java,indent=0,subs="verbatim,quotes"]
870870
----

framework-docs/modules/ROOT/pages/core/beans/factory-nature.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ based on the given configuration but no further activity with external bean acce
144144
Otherwise there is a risk for an initialization deadlock.
145145
146146
For a scenario where expensive post-initialization activity is to be triggered,
147-
e.g. asynchronous database preparation steps, your bean should either implement
147+
for example, asynchronous database preparation steps, your bean should either implement
148148
`SmartInitializingSingleton.afterSingletonsInstantiated()` or rely on the context
149149
refresh event: implementing `ApplicationListener<ContextRefreshedEvent>` or
150150
declaring its annotation equivalent `@EventListener(ContextRefreshedEvent.class)`.
@@ -607,7 +607,7 @@ bean creation phase and its subsequent initial publication, they need to be decl
607607
`volatile` or guarded by a common lock whenever accessed.
608608

609609
Note that concurrent access to such configuration state in singleton bean instances,
610-
e.g. for controller instances or repository instances, is perfectly thread-safe after
610+
for example, for controller instances or repository instances, is perfectly thread-safe after
611611
such safe initial publication from the container side. This includes common singleton
612612
`FactoryBean` instances which are processed within the general singleton lock as well.
613613

@@ -617,7 +617,7 @@ structures (or in `volatile` fields for simple cases) as per common Java guideli
617617

618618
Deeper `Lifecycle` integration as shown above involves runtime-mutable state such as
619619
a `runnable` field which will have to be declared as `volatile`. While the common
620-
lifecycle callbacks follow a certain order, e.g. a start callback is guaranteed to
620+
lifecycle callbacks follow a certain order, for example, a start callback is guaranteed to
621621
only happen after full initialization and a stop callback only after an initial start,
622622
there is a special case with the common stop before destroy arrangement: It is strongly
623623
recommended that the internal state in any such bean also allows for an immediate

framework-docs/modules/ROOT/pages/core/beans/java/composing-configuration-classes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ parameter-based injection, as in the preceding example.
219219
Avoid access to locally defined beans within a `@PostConstruct` method on the same configuration
220220
class. This effectively leads to a circular reference since non-static `@Bean` methods semantically
221221
require a fully initialized configuration class instance to be called on. With circular references
222-
disallowed (e.g. in Spring Boot 2.6+), this may trigger a `BeanCurrentlyInCreationException`.
222+
disallowed (for example, in Spring Boot 2.6+), this may trigger a `BeanCurrentlyInCreationException`.
223223
224224
Also, be particularly careful with `BeanPostProcessor` and `BeanFactoryPostProcessor` definitions
225225
through `@Bean`. Those should usually be declared as `static @Bean` methods, not triggering the

framework-docs/modules/ROOT/pages/core/databuffer-codec.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ a `DataBuffer` implementation and that does not involve allocation.
2929

3030
Note that WebFlux applications do not create a `DataBufferFactory` directly but instead
3131
access it through the `ServerHttpResponse` or the `ClientHttpRequest` on the client side.
32-
The type of factory depends on the underlying client or server, e.g.
32+
The type of factory depends on the underlying client or server, for example,
3333
`NettyDataBufferFactory` for Reactor Netty, `DefaultDataBufferFactory` for others.
3434

3535

@@ -82,7 +82,7 @@ to use the convenience methods in `DataBufferUtils` that apply release or retain
8282

8383
`DataBufferUtils` offers a number of utility methods to operate on data buffers:
8484

85-
* Join a stream of data buffers into a single buffer possibly with zero copy, e.g. via
85+
* Join a stream of data buffers into a single buffer possibly with zero copy, for example, via
8686
composite buffers, if that's supported by the underlying byte buffer API.
8787
* Turn `InputStream` or NIO `Channel` into `Flux<DataBuffer>`, and vice versa a
8888
`Publisher<DataBuffer>` into `OutputStream` or NIO `Channel`.

framework-docs/modules/ROOT/pages/core/validation/beans-beans.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ manner, but through a nested property path. That means constructor binding creat
3838
the target object and any objects it contains.
3939

4040
Constructor binding supports `List`, `Map`, and array arguments either converted from
41-
a single string, e.g. comma-separated list, or based on indexed keys such as
41+
a single string, for example, comma-separated list, or based on indexed keys such as
4242
`accounts[2].name` or `account[KEY].name`.
4343

4444
Binding and conversion errors are reflected in the `BindingResult` of the `DataBinder`.

framework-docs/modules/ROOT/pages/core/validation/format.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Kotlin::
318318
The `FormatterRegistry` is an SPI for registering formatters and converters.
319319
`FormattingConversionService` is an implementation of `FormatterRegistry` suitable for
320320
most environments. You can programmatically or declaratively configure this variant
321-
as a Spring bean, e.g. by using `FormattingConversionServiceFactoryBean`. Because this
321+
as a Spring bean, for example, by using `FormattingConversionServiceFactoryBean`. Because this
322322
implementation also implements `ConversionService`, you can directly configure it
323323
for use with Spring's `DataBinder` and the Spring Expression Language (SpEL).
324324

framework-docs/modules/ROOT/pages/core/validation/validator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ not involving a binding process. As of 6.1, this has been simplified through a n
200200
`Validator.validateObject(Object)` method which is available by default now, returning
201201
a simple ´Errors` representation which can be inspected: typically calling `hasErrors()`
202202
or the new `failOnError` method for turning the error summary message into an exception
203-
(e.g. `validator.validateObject(myObject).failOnError(IllegalArgumentException::new)`).
203+
(for example, `validator.validateObject(myObject).failOnError(IllegalArgumentException::new)`).
204204

205205

206206

framework-docs/modules/ROOT/pages/data-access/jdbc/advanced.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ As of 6.1.2, Spring bypasses the default `getParameterType` resolution on Postgr
223223
MS SQL Server. This is a common optimization to avoid further roundtrips to the DBMS just
224224
for parameter type resolution which is known to make a very significant difference on
225225
PostgreSQL and MS SQL Server specifically, in particular for batch operations. If you
226-
happen to see a side effect e.g. when setting a byte array to null without specific type
226+
happen to see a side effect, for example, when setting a byte array to null without specific type
227227
indication, you may explicitly set the `spring.jdbc.getParameterType.ignore=false` flag
228228
as a system property (see above) to restore full `getParameterType` resolution.
229229

framework-docs/modules/ROOT/pages/data-access/jdbc/connections.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ corresponding `DataSource` proxy class for the target connection pool: see
177177
This is particularly useful for potentially empty transactions without actual statement
178178
execution (never fetching an actual resource in such a scenario), and also in front of
179179
a routing `DataSource` which means to take the transaction-synchronized read-only flag
180-
and/or isolation level into account (e.g. `IsolationLevelDataSourceRouter`).
180+
and/or isolation level into account (for example, `IsolationLevelDataSourceRouter`).
181181

182182
`LazyConnectionDataSourceProxy` also provides special support for a read-only connection
183183
pool to use during a read-only transaction, avoiding the overhead of switching the JDBC

framework-docs/modules/ROOT/pages/data-access/orm/jpa.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ a context-wide `LoadTimeWeaver` by using the `@EnableLoadTimeWeaving` annotation
175175
`context:load-time-weaver` XML element. Such a global weaver is automatically picked up
176176
by all JPA `LocalContainerEntityManagerFactoryBean` instances. The following example
177177
shows the preferred way of setting up a load-time weaver, delivering auto-detection
178-
of the platform (e.g. Tomcat's weaving-capable class loader or Spring's JVM agent)
178+
of the platform (for example, Tomcat's weaving-capable class loader or Spring's JVM agent)
179179
and automatic propagation of the weaver to all weaver-aware beans:
180180

181181
[source,xml,indent=0,subs="verbatim,quotes"]
@@ -469,7 +469,7 @@ a non-invasiveness perspective and can feel more natural to JPA developers.
469469
What about providing JPA resources via constructors and other `@Autowired` injection points?
470470

471471
`EntityManagerFactory` can easily be injected via constructors and `@Autowired` fields/methods
472-
as long as the target is defined as a bean, e.g. via `LocalContainerEntityManagerFactoryBean`.
472+
as long as the target is defined as a bean, for example, via `LocalContainerEntityManagerFactoryBean`.
473473
The injection point matches the original `EntityManagerFactory` definition by type as-is.
474474

475475
However, an `@PersistenceContext`-style shared `EntityManager` reference is not available for

framework-docs/modules/ROOT/pages/data-access/r2dbc.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -469,10 +469,10 @@ Kotlin::
469469

470470
NOTE: R2DBC itself does not support Collection-like values. Nevertheless,
471471
expanding a given `List` in the example above works for named parameters
472-
in Spring's R2DBC support, e.g. for use in `IN` clauses as shown above.
473-
However, inserting or updating array-typed columns (e.g. in Postgres)
472+
in Spring's R2DBC support, for example, for use in `IN` clauses as shown above.
473+
However, inserting or updating array-typed columns (for example, in Postgres)
474474
requires an array type that is supported by the underlying R2DBC driver:
475-
typically a Java array, e.g. `String[]` to update a `text[]` column.
475+
typically a Java array, for example, `String[]` to update a `text[]` column.
476476
Do not pass `Collection<String>` or the like as an array parameter.
477477

478478
[[r2dbc-DatabaseClient-filter]]

framework-docs/modules/ROOT/pages/data-access/transaction/declarative/annotations.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ the proxy are intercepted. This means that self-invocation (in effect, a method
250250
the target object calling another method of the target object) does not lead to an actual
251251
transaction at runtime even if the invoked method is marked with `@Transactional`. Also,
252252
the proxy must be fully initialized to provide the expected behavior, so you should not
253-
rely on this feature in your initialization code -- e.g. in a `@PostConstruct` method.
253+
rely on this feature in your initialization code -- for example, in a `@PostConstruct` method.
254254

255255
Consider using AspectJ mode (see the `mode` attribute in the following table) if you
256256
expect self-invocations to be wrapped with transactions as well. In this case, there is
@@ -564,7 +564,7 @@ transaction definitions from a base class as well. This effectively overrides
564564
the default transaction manager choice for any unqualified base class methods.
565565
566566
Last but not least, such a type-level bean qualifier can serve multiple purposes,
567-
e.g. with a value of "order" it can be used for autowiring purposes (identifying
567+
for example, with a value of "order" it can be used for autowiring purposes (identifying
568568
the order repository) as well as transaction manager selection, as long as the
569569
target beans for autowiring as well as the associated transaction manager
570570
definitions declare the same qualifier value. Such a qualifier value only needs

framework-docs/modules/ROOT/pages/data-access/transaction/declarative/tx-decl-explained.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ operations need to execute within the same Reactor context in the same reactive
4141
4242
When configured with a `ReactiveTransactionManager`, all transaction-demarcated methods
4343
are expected to return a reactive pipeline. Void methods or regular return types need
44-
to be associated with a regular `PlatformTransactionManager`, e.g. through the
44+
to be associated with a regular `PlatformTransactionManager`, for example, through the
4545
`transactionManager` attribute of the corresponding `@Transactional` declarations.
4646
====
4747

framework-docs/modules/ROOT/pages/integration/cache/annotations.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,12 +501,12 @@ Placing this annotation on the class does not turn on any caching operation.
501501
An operation-level customization always overrides a customization set on `@CacheConfig`.
502502
Therefore, this gives three levels of customizations for each cache operation:
503503

504-
* Globally configured, e.g. through `CachingConfigurer`: see next section.
504+
* Globally configured, for example, through `CachingConfigurer`: see next section.
505505
* At the class level, using `@CacheConfig`.
506506
* At the operation level.
507507

508508
NOTE: Provider-specific settings are typically available on the `CacheManager` bean,
509-
e.g. on `CaffeineCacheManager`. These are effectively also global.
509+
for example, on `CaffeineCacheManager`. These are effectively also global.
510510

511511

512512
[[cache-annotation-enable]]

framework-docs/modules/ROOT/pages/integration/rest-clients.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ If no request factory is specified when the `RestClient` was built, it will use
433433
Otherwise, if the `java.net.http` module is loaded, it will use Java's `HttpClient`.
434434
Finally, it will resort to the simple default.
435435

436-
TIP: Note that the `SimpleClientHttpRequestFactory` may raise an exception when accessing the status of a response that represents an error (e.g. 401).
436+
TIP: Note that the `SimpleClientHttpRequestFactory` may raise an exception when accessing the status of a response that represents an error (for example, 401).
437437
If this is an issue, use any of the alternative request factories.
438438

439439
[[rest-webclient]]
@@ -966,7 +966,7 @@ method parameters:
966966

967967
| `@RequestPart`
968968
| Add a request part, which may be a String (form field), `Resource` (file part),
969-
Object (entity to be encoded, e.g. as JSON), `HttpEntity` (part content and headers),
969+
Object (entity to be encoded, for example, as JSON), `HttpEntity` (part content and headers),
970970
a Spring `Part`, or Reactive Streams `Publisher` of any of the above.
971971

972972
| `MultipartFile`

framework-docs/modules/ROOT/pages/integration/scheduling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ seconds:
483483
====
484484
When destroying the annotated bean or closing the application context, Spring Framework cancels
485485
scheduled tasks, which includes the next scheduled subscription to the `Publisher` as well
486-
as any past subscription that is still currently active (e.g. for long-running publishers
486+
as any past subscription that is still currently active (for example, for long-running publishers
487487
or even infinite publishers).
488488
====
489489

framework-docs/modules/ROOT/pages/languages/dynamic.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ objects.
1010
Spring's scripting support primarily targets Groovy and BeanShell. Beyond those
1111
specifically supported languages, the JSR-223 scripting mechanism is supported
1212
for integration with any JSR-223 capable language provider (as of Spring 4.2),
13-
e.g. JRuby.
13+
for example, JRuby.
1414

1515
You can find fully working examples of where this dynamic language support can be
1616
immediately useful in xref:languages/dynamic.adoc#dynamic-language-scenarios[Scenarios].
@@ -179,7 +179,7 @@ Each of the supported languages has a corresponding `<lang:language/>` element:
179179

180180
* `<lang:groovy/>` (Groovy)
181181
* `<lang:bsh/>` (BeanShell)
182-
* `<lang:std/>` (JSR-223, e.g. with JRuby)
182+
* `<lang:std/>` (JSR-223, for example, with JRuby)
183183

184184
The exact attributes and child elements that are available for configuration depends on
185185
exactly which language the bean has been defined in (the language-specific sections

framework-docs/modules/ROOT/pages/overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ developers may choose to use instead of the Spring-specific mechanisms provided
7373
by the Spring Framework. Originally, those were based on common `javax` packages.
7474

7575
As of Spring Framework 6.0, Spring has been upgraded to the Jakarta EE 9 level
76-
(e.g. Servlet 5.0+, JPA 3.0+), based on the `jakarta` namespace instead of the
76+
(for example, Servlet 5.0+, JPA 3.0+), based on the `jakarta` namespace instead of the
7777
traditional `javax` packages. With EE 9 as the minimum and EE 10 supported already,
7878
Spring is prepared to provide out-of-the-box support for the further evolution of
7979
the Jakarta EE APIs. Spring Framework 6.0 is fully compatible with Tomcat 10.1,

0 commit comments

Comments
 (0)