[
https://issues.apache.org/jira/browse/COUCHDB-1924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13818146#comment-13818146
]
Alexander Shorin commented on COUCHDB-1924:
-------------------------------------------
This is the tradeoff: on one hand you're right and user might expect to see all
examples right at endpoint's method description. On other hand these examples
will be left without direct references: you have to jump to endpoint's method
description and scroll down, and down, and down to find example that fits your
needs. This would be a bit unhandy for GET methods since they're have a lot of
query parameters that affects on response data. More over, these examples
sometimes has rich
[annotation|http://docs.couchdb.org/en/latest/api/database/bulk-api.html#inserting-documents-in-bulk]
to explain what's going on there and why.
Alternatively, there could be `..seealso::` block that contains all references
to the related section for specific endpoint method's, but there is also handy
toctree at the sidebar which is hard to miss.
> Add an example for updating a document with PUT
> -----------------------------------------------
>
> Key: COUCHDB-1924
> URL: https://issues.apache.org/jira/browse/COUCHDB-1924
> Project: CouchDB
> Issue Type: Documentation
> Components: Documentation
> Reporter: Andy Wenk
> Assignee: Andy Wenk
>
> An example for updating a document with PUT is missing in the documentation
> at http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid .
> It should be added as a second example.
--
This message was sent by Atlassian JIRA
(v6.1#6144)
