[ 
https://issues.apache.org/jira/browse/COUCHDB-1924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13818092#comment-13818092
 ] 

Andy Wenk commented on COUCHDB-1924:
------------------------------------

[my comment is a little longer, because I think this is something to be 
discussed in general for the whole documentation]

Yes I know - I have written this in the commit message. I thought it is better 
to have it next to the definition because

as a user of the API documentation
I want to find all examples for sending the described request
so that I don't have to search or look at another place for examples

I always dislike the fact, that something is described in a documentation and 
the examples do not cover the main possibilities. But I understand the idea 
with having just one example here and it's ok to have a link to the Update 
section. But I still believe it's better to have it at one place.

Any other thought? If not, I'm gonna change it with removing the new parts and 
insert a link. 

> 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)

Reply via email to