This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko-http.git
The following commit(s) were added to refs/heads/main by this push:
new aec584c8e fix: correct typos in pekko-http docs and tests (#1075)
aec584c8e is described below
commit aec584c8e82c1a45d108015e9650a8d03d0ee40c
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Fri Jun 19 16:42:41 2026 +0800
fix: correct typos in pekko-http docs and tests (#1075)
* fix: correct typos in pekko-http docs and tests
Motivation:
Typos found in documentation markdown files and test code.
Modification:
- Appache→Apache in timeouts.md (2 occurrences)
- bellow→below in host.md
- programatically→programmatically in extractMethod.md
- noone→no one in security directives docs
- decodeing→decoding in CodingDirectivesSpec.scala
- nexting→nesting in PathDirectivesTest.java
Result:
Cleaner codebase with corrected spelling.
Tests:
Not run - typo fixes only (docs and test strings)
References:
None - typo cleanup
* fix: revert noone change per CR feedback
Motivation:
CR review comment from pjfanning: "noone is correct as is".
Modification:
Revert the noone → no one change in security-directives/index.md.
Result:
Original spelling preserved per maintainer feedback.
Tests:
Not run - doc string revert only
References:
Fixes https://github.com/apache/pekko-http/pull/1075#discussion_r3438926033
---
docs/src/main/paradox/common/timeouts.md | 4 ++--
docs/src/main/paradox/routing-dsl/directives/host-directives/host.md | 2 +-
.../paradox/routing-dsl/directives/method-directives/extractMethod.md | 2 +-
.../pekko/http/javadsl/server/directives/PathDirectivesTest.java | 2 +-
.../pekko/http/scaladsl/server/directives/CodingDirectivesSpec.scala | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/src/main/paradox/common/timeouts.md
b/docs/src/main/paradox/common/timeouts.md
index 842ae8293..aaf08a8a5 100644
--- a/docs/src/main/paradox/common/timeouts.md
+++ b/docs/src/main/paradox/common/timeouts.md
@@ -51,11 +51,11 @@ It can be configured using the
`pekko.http.server.bind-timeout` setting.
The linger timeout is the time period the HTTP server implementation will keep
a connection open after
all data has been delivered to the network layer. This setting is similar to
the SO_LINGER socket option
-but does not only include the OS-level socket but also covers the Appache
Pekko IO and Streams network stack.
+but does not only include the OS-level socket but also covers the Apache Pekko
IO and Streams network stack.
The setting is an extra precaution that prevents clients from keeping open a
connection that is
already considered completed from the server side.
-If the network level buffers (including the Appache Pekko IO and Streams
networking stack buffers)
+If the network level buffers (including the Apache Pekko IO and Streams
networking stack buffers)
contains more data than can be transferred to the client in the given time
when the server-side considers
to be finished with this connection, the client may encounter a connection
reset.
diff --git
a/docs/src/main/paradox/routing-dsl/directives/host-directives/host.md
b/docs/src/main/paradox/routing-dsl/directives/host-directives/host.md
index ecd02993c..e215fcd9b 100644
--- a/docs/src/main/paradox/routing-dsl/directives/host-directives/host.md
+++ b/docs/src/main/paradox/routing-dsl/directives/host-directives/host.md
@@ -67,7 +67,7 @@ Scala
Java
: @@snip
[HostDirectivesExamplesTest.java](/docs/src/test/java/docs/http/javadsl/server/directives/HostDirectivesExamplesTest.java)
{ #matchAndExtractHost }
-Beware that in the case of introducing multiple capturing groups in the regex
such as in the case bellow, the
+Beware that in the case of introducing multiple capturing groups in the regex
such as in the case below, the
directive will fail at runtime, at the moment the route tree is evaluated for
the first time. This might cause
your http handler actor to enter in a fail/restart loop depending on your
supervision strategy.
diff --git
a/docs/src/main/paradox/routing-dsl/directives/method-directives/extractMethod.md
b/docs/src/main/paradox/routing-dsl/directives/method-directives/extractMethod.md
index a784fee9b..2e8af8ba8 100644
---
a/docs/src/main/paradox/routing-dsl/directives/method-directives/extractMethod.md
+++
b/docs/src/main/paradox/routing-dsl/directives/method-directives/extractMethod.md
@@ -15,7 +15,7 @@ Extracts the @apidoc[HttpMethod] from the request context and
provides it for us
## Example
In the below example our route first matches all `GET` requests, and if an
incoming request wasn't a `GET`,
-the matching continues and the extractMethod route will be applied which we
can use to programatically
+the matching continues and the extractMethod route will be applied which we
can use to programmatically
print what type of request it was - independent of what actual HttpMethod it
was:
Scala
diff --git
a/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/PathDirectivesTest.java
b/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/PathDirectivesTest.java
index a5d8172fe..377239b18 100644
---
a/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/PathDirectivesTest.java
+++
b/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/PathDirectivesTest.java
@@ -185,7 +185,7 @@ public class PathDirectivesTest extends
JUnitJupiterRouteTest {
TestRoute route =
testRoute(
// this is testing that we can express the same path using slash()
and concat() as with
- // nexting inside slash()
+ // nesting inside slash()
path(
segment("age").slash().concat(integerSegment()),
value -> complete(value.toString())));
diff --git
a/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/CodingDirectivesSpec.scala
b/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/CodingDirectivesSpec.scala
index a2d92044a..1c0b1adc0 100644
---
a/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/CodingDirectivesSpec.scala
+++
b/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/CodingDirectivesSpec.scala
@@ -508,7 +508,7 @@ class CodingDirectivesSpec extends RoutingSpec with Inside {
rejection shouldEqual UnsupportedRequestEncodingRejection(gzip)
}
}
- "reject the request when decodeing with GZIP and no Content-Encoding
header is present" in {
+ "reject the request when decoding with GZIP and no Content-Encoding header
is present" in {
Post("/", "yes") ~> decodeRequestWith(Gzip) { echoRequestContent } ~>
check {
rejection shouldEqual UnsupportedRequestEncodingRejection(gzip)
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]