Mailing-List: contact user-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: user@couchdb.apache.org
Received-SPF: pass (athena.apache.org: domain of dicky.dicky@gmail.com
 designates 209.85.160.52 as permitted sender)
Received-SPF: pass (google.com: domain of dicky.dicky@gmail.com designates
 10.68.72.70 as permitted sender) client-ip=10.68.72.70;
MIME-Version: 1.0
Sender: dicky.dicky@gmail.com
In-Reply-To: 
 <CAHWjJFYABc1GdU9_n94gdy747R3pAgDOYR_WUPRjkHdiX+uMuQ@mail.gmail.com>
References: 
 <CAHWjJFbbD5OvsCt0ypsAshpm9NPFpqKWTK2bi5Jbs7hrd4907Q@mail.gmail.com>
	<CAHWjJFYABc1GdU9_n94gdy747R3pAgDOYR_WUPRjkHdiX+uMuQ@mail.gmail.com>
Date: Sat, 25 Feb 2012 00:12:48 +0100
Message-ID: 
 <CANMd5FxGU-KiHrJTnxU8ZDVWaHViJ1STN7qFsjsM0_Vsbs2r5A@mail.gmail.com>
Subject: Re: Comments in design doucment
From: Dirk Heilig <dirk@heilig-online.com>
To: user@couchdb.apache.org
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

Hi Ian,
i don't get the point.
i comment my map / reduce functions just like i comment all my other
code in ohrer places, like this:

//this is my map function to map all docs
function(doc) {
  //i jost emit every doc
  emit(null, doc);
}

which results in a valid json like this:


{
   "_id": "_design/delme",
   "_rev": "1-bed099dd4d01031ac4c177f5d7acf372",
   "language": "javascript",
   "views": {
       "delme": {
           "map": "//this is my map function to map all
docs\nfunction(doc) {\n  //i jost emit every doc\n  emit(null,
doc);\n}"
       }
   }
}


in my opinion thats the right way, because i'am commenting the code,
not the data..

dirk
2012/2/24 Ian Mayo <ian@planetmayo.com>:
> thanks for the advice chaps.
>
> I now realise this isn't something CouchDb specific, it's JSON
> specific. =C2=A0The workaround is to add a comment as a field, as describ=
ed
> here:
> http://stackoverflow.com/questions/244777/can-i-comment-a-json-file
>
>
> On 23 February 2012 15:44, Ian Mayo <ian@planetmayo.com> wrote:
>> Hi all,
>> like a good software engineer I'm trying to document my code.
>>
>> But, each time I try to put a // or /* comment into my design document
>> the transfer to couchdb fails.
>>
>> Is there a way of putting comments into a design document?
>>
>> cheers,
>> Ian