[
https://issues.apache.org/jira/browse/HTTPCLIENT-1201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13288805#comment-13288805
]
miles zarathustra commented on HTTPCLIENT-1201:
-----------------------------------------------
I'll see what I can do about providing a documentation patch. The
documentation change I'm proposing is actually quite simple, as I described
above. If someone else wants to do it, I'm fine with that, too.
Plain POST and GET are simple, common cases. It would thus seem logical to
place them above the more complex ones. More or less, that's all I'm saying.
Likewise, maybe the title "produce entity content" could appear as subtitle or
subsection? From a user's standpoint, the main task is "POST." It's simply a
matter of organizing the outline structure logically.
Let me think about a more intuitive Builder class. That won't happen soon, but
if you might be receptive to it I would think about writing one. There is a
groovy API that attempts to provide a more intuitive interface to httpclient,
but it has been a while since I looked at it.
I should think simple and flexible could coexist were the layering done
properly.
I find this attitude of "don't submit any criticism unless you are willing to
submit to our guilt trip" is a bit odd.
Whatever.
> provide basic documentation in an obvious place
> -----------------------------------------------
>
> Key: HTTPCLIENT-1201
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1201
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.2 Final
> Reporter: miles zarathustra
>
> The only documentation obviously linked from the main HttpClient page is the
> "tutorial." This "tutorial" talks about a lot of esoteric arcane junk I
> don't care about, but gives no clue on how to send parameters via a basic
> post. For that, I have to go here:
> http://wiki.apache.org/HttpComponents/QuickStart
> It's very difficult to find, and it's a lot easier to google examples that
> don't work. I wound up trying 4 different purported solutions before I found
> this one that works. If you look around the web you'll notice that people
> generally find the httpclient documentation frustrating. I have colleagues
> who argue that it would be easier to just write the post logic from scratch
> than figure out how the silly apache stuff works, and it's difficult for me
> to contradict them.
> It would be SO easy to improve the situation by making links to already
> available examples of the basic operations in an obvious place.
> The FAQ that explains some things about WHY the posts work in the totally
> non-intuitive way that they do would be nice also.
> Thanks.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
