beast icon indicating copy to clipboard operation
beast copied to clipboard

Published 20 hours ago • verified publisher icon boostorg

Proper Documentation on http::request and http::response

Open xhimanshuz opened this issue 3 years ago • 12 comments

In boost Beast documentation nowhere mentioning how to properly create the Request and Response object. Boost Beast Reference page is missing some basic things, So, I have to watch all your great talk to make me motivated to use Beast even if these are too great and knowledgeable, can't cover all the Beast features. I really like how fast you try to cover the content in a limited time.

As for reference, these are the reference page for the Response, Request class, and file_body class. https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__request.html https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__response.html https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__file_body.html

There should be some example at the end of all references, So People get to know how to use them. I know it's time-consuming but please cover at least basic concepts So, New people like me at least know how to use basic functionality. I have read example Its great still haven't mentioned how to create request and response object.

xhimanshuz avatar Apr 15 '21 03:04 xhimanshuz

This issue has been open for a while with no activity, has it been resolved?

stale[bot] avatar May 29 '21 16:05 stale[bot]

No

xhimanshuz avatar May 29 '21 23:05 xhimanshuz

What's going on with this? @madmongo1

vinniefalco avatar Jul 19 '21 17:07 vinniefalco

This issue has been open for a while with no activity, has it been resolved?

stale[bot] avatar Jan 09 '22 03:01 stale[bot]

No

xhimanshuz avatar Jan 11 '22 10:01 xhimanshuz

I am trying to think how I can best cover the needed information. Do you think one example that covers the use of each method would be the right thing, or do you think a little example for each method would be better?

madmongo1 avatar Jan 11 '22 18:01 madmongo1

So People get to know how to use them

@madmongo1 So, I mentioned, If you add an example at the end of the page of reference, It will be easy to learn and use.

xhimanshuz avatar Jan 12 '22 13:01 xhimanshuz

A reference is not the place to learn, it's to be used by developers already familiar with the library. You shouldn't use the cppreference as an intro to C++ either. While I get that more examples are always better, the response & request objects are seldolmy used alone, and the doc has multiple examples of how to use them right here under Quick look : https://www.boost.org/doc/libs/1_80_0/libs/beast/doc/html/index.html

People might be thrown off by the reference being on the top of the ToC.

klemens-morgenstern avatar Sep 24 '22 05:09 klemens-morgenstern