Mailing-List: contact callback-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: callback-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of fil@adobe.com designates
 64.18.1.189 as permitted sender)
From: Filip Maj <fil@adobe.com>
To: "callback-dev@incubator.apache.org" <callback-dev@incubator.apache.org>
Date: Thu, 26 Apr 2012 11:18:46 -0700
Subject: Re: [ATTENTION MENTORS] Need help re: headers in docs
Thread-Topic: [ATTENTION MENTORS] Need help re: headers in docs
Thread-Index: Ac0j2KqDB2ObRg/6RN6tDgQpsJMU1Q==
Message-ID: <CBBEDF80.524A%fil@adobe.com>
In-Reply-To: 
 <CAOFYJNb1h3ouyuw1_mL38cUCLtSBAnQiVz3MucQ9L9vwP+zotw@mail.gmail.com>
Accept-Language: en-US
Content-Language: en-US
user-agent: Microsoft-MacOutlook/14.2.0.120402
acceptlanguage: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0

Thanks for the reply Jukka.

Sucks that a majority of our documentation markdown files will be > 50%
license :(

On 4/26/12 9:17 AM, "Jukka Zitting" <jukka.zitting@gmail.com> wrote:

>Hi,
>
>On Wed, Apr 25, 2012 at 11:15 PM, Filip Maj <fil@adobe.com> wrote:
>> Can any mentor please take a quick peek at the issue?
>
>Sorry for the delay. See my comment on the issue.
>
>> Also, a point that Mike brought up, is that we don't want comments in
>>the
>> markdown (defeats the purpose of using markdown for clean, simple
>> documentation), so if possible, would like to stick to having the
>>headers
>> in just the scripts files that generate the docs, or the final generated
>> documentation HTML.
>
>Since those files are something that someone may well want to copy,
>use and modify separately, they should come with a source headers.
>
>Using the <!-- comment --> format should hide the headers from the
>user-visible HTML docs, but still keeps them visible to anyone
>modifying the files.
>
>BR,
>
>Jukka Zitting