[jira] [Commented] (COUCHDB-1931) documentation on shows and lists in misleading

["Robert Newson (JIRA)" <ji...@apache.org>]

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

Robert Newson commented on COUCHDB-1931:
----------------------------------------

The rendering case was the motivating one, though, right?

Anyway, I agree on changing the text but probably in the opposite direction to you. Given the performance issues, I'd like us to state that "show and list functions are useful if you need to serve a different output format for clients incapable of processing JSON".

If you *can* process JSON then you'll almost always perform far better by doing so. Whether that's a separate application written in anything or some Javascript running in a browser served from a couchdb attachment.


> documentation on shows and lists in misleading
> ----------------------------------------------
>
>                 Key: COUCHDB-1931
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1931
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Benoit Chesneau
>
> The doc says for the shows:
> {quote}
> Show functions are used to represent documents in various formats, commonly as HTML page with nicer formatting. They can also be used to run server-side functions without requiring a pre-existing document.
> {quote}
> and later for the lists:
> {quote}
> While Show functions are used to customize document presentation, List functions are used for same purpose, but against View functions results.
> {quote}
> We shouldn't speak of rendering or not only. Shows are about transforming the results depending on the parameters you pass on the URL. Rendering is just one of the possibilities due to the ability of transforming and editing the result(s). 
> We should make it more clear.



--
This message was sent by Atlassian JIRA
(v6.1#6144)