Asciidocs for Vertx Core Http can improve

[donders]

The Vertx Core docs on the topic of Http have various mistakes which reduce readability.

Examples:

• A paragraph with the heading "Reading the request body" refers to the response body:
• The first code block of this paragraph exemplifies incorrect usage, but isn't labelled as such:
• Aside from that there are some minor verb conjugation flubs. Easily fixed, but understandably dull. I might correct those down the road

I'm working on streaming the body of a response using Smallrye Mutiny, and between these libraries' documentation, it got a little confusing trying to keep track of the various mappings.

[vietj]

do you mind providing a patch to improve the docs ?

On Wed, Jun 23, 2021 at 4:41 PM donders @.***> wrote:

The Vertx Core docs on the topic of Http have various mistakes which reduce readability.

Examples:

• A paragraph with the heading "Reading the request body https://github.com/eclipse-vertx/vert.x/blame/4.1.0/src/main/asciidoc/http.adoc#L1053" refers to the response body:
• The first code block of this paragraph https://github.com/eclipse-vertx/vert.x/blame/4.1.0/src/main/asciidoc/http.adoc#L1090 exemplifies incorrect usage, but isn't labelled as such:
• Aside from that there are some minor verb conjugation flubs. Easily fixed, but understandably dull. I might correct those down the road

I'm working on streaming the body of a response using Smallrye Mutiny, and between these libraries' documentation, it got a little confusing trying to keep track of the various mappings.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/eclipse-vertx/vert.x/issues/3983, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABXDCQUHOLEGYLKEZCYKATTUHXBBANCNFSM47F6OAWA .