Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

Looks good!

Robert Dale

On Tue, Sep 26, 2017 at 1:38 PM, Daniel Kuppitz  wrote:

> Yea, that was the right regex to look for these errors: grep '^== $'
> $(find . -name "*.asciidoc")
> Got them all now, will push the fix in a few.
>
> Cheers,
> Daniel
>
>
> On Tue, Sep 26, 2017 at 10:30 AM, Robert Dale  wrote:
>
> > docs/src/reference/gremlin-applications.asciidoc:
> > @@ -294,8 +288,7 @@ v[2]
> >  v[3]
> >  v[4]
> >  v[5]
> > -v[6]
> > -
> > +== v[6]
> >
> >  It is also possible to pass arguments to scripts.  Any parameters
> > following the file name specification are treated
> >  as arguments to the script. They are collected into a list and passed in
> > as a variable called "args".  The following
> > @@ -316,8 +309,7 @@ When executed from the command line a parameter can
> be
> > supplied:
> >  $ bin/gremlin.sh -e gremlin.groovy marko
> >  v[1]
> >  $ bin/gremlin.sh -e gremlin.groovy vadas
> > -v[2]
> > -
> > +== v[2]
> >
> >
> >
> > Robert Dale
> >
> > On Tue, Sep 26, 2017 at 1:22 PM, Robert Dale  wrote:
> >
> > > Looks like master CHANGELOG picked up a conflict...
> > >
> > > <<< HEAD
> > > == TinkerPop 3.3.0 (Gremlin Symphony #40 in G Minor)
> > > .
> > > .
> > > .
> > >
> > > == TinkerPop 3.2.0 (Nine Inch Gremlins)
> > > ===
> > > == TinkerPop 3.2.0 (Nine Inch Gremlins)
> > > >>> asciidoc-header
> > >
> > >
> > > Robert Dale
> > >
> > > On Tue, Sep 26, 2017 at 1:19 PM, Daniel Kuppitz 
> wrote:
> > >
> > >> Ah, good find! That's the same issue I've had in the reference docs
> and
> > >> recipes. Fixed.
> > >>
> > >> Cheers,
> > >> Daniel
> > >>
> > >>
> > >> On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale 
> > wrote:
> > >>
> > >> > git grep "== =="
> > >> >
> > >> > Robert Dale
> > >> >
> > >> > On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale 
> > wrote:
> > >> >
> > >> > > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
> > >> > > x-incubating.html
> > >> > >
> > >> > > Robert Dale
> > >> > >
> > >> > > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale 
> > >> wrote:
> > >> > >
> > >> > >> ^d
> > >> > >>
> > >> > >> Robert Dale
> > >> > >>
> > >> > >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz  >
> > >> > wrote:
> > >> > >>
> > >> > >>> This is one. I pushed the changes to tp32/ and master/. I only
> > found
> > >> > (and
> > >> > >>> fixed) 2 minor issues, where my script produced a little
> > formatting
> > >> > mess.
> > >> > >>>
> > >> > >>> Cheers,
> > >> > >>> Daniel
> > >> > >>>
> > >> > >>>
> > >> > >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
> > >> > spmalle...@gmail.com>
> > >> > >>> wrote:
> > >> > >>>
> > >> > >>> > For whatever reason we started writing our headers in our docs
> > >> with:
> > >> > >>> >
> > >> > >>> > Header
> > >> > >>> > ==
> > >> > >>> >
> > >> > >>> > Subheader
> > >> > >>> > -
> > >> > >>> >
> > >> > >>> > SubSubHeader
> > >> > >>> > 
> > >> > >>> >
> > >> > >>> > as opposed to the alternative:
> > >> > >>> >
> > >> > >>> > = This Is A Header
> > >> > >>> >
> > >> > >>> > == Subheader
> > >> > >>> >
> > >> > >>> > === SubSubHeader
> > >> > >>> >
> > >> > >>> > The downside with the first approach is that it forces us to
> do
> > >> two
> > >> > >>> things:
> > >> > >>> >
> > >> > >>> > 1. Remember the syntax for each header layer (which we all
> > >> probably
> > >> > >>> know
> > >> > >>> > pretty well at this point, but still...)
> > >> > >>> > 2. Ensure that the width of the header formatting line is
> equal
> > to
> > >> > the
> > >> > >>> > length of the text above it.
> > >> > >>> >
> > >> > >>> > That second point is a killer sometimes. While I've trained
> > >> myself to
> > >> > >>> be
> > >> > >>> > good at noticing that problem I know it's bitten us in
> releases
> > >> over
> > >> > >>> and
> > >> > >>> > over and over again.
> > >> > >>> >
> > >> > >>> > Anyway, I think going to the alternative formatting would be
> > >> better
> > >> > and
> > >> > >>> > propose to do a full reformatting. Please let me know if there
> > are
> > >> > any
> > >> > >>> > concerns about doing that - if I don't hear back in the next
> few
> > >> days
> > >> > >>> I'll
> > >> > >>> > proceed with the changes.
> > >> > >>> >
> > >> > >>> > Thanks,
> > >> > >>> >
> > >> > >>> > Stephen
> > >> > >>> >
> > >> > >>>
> > >> > >>
> > >> > >>
> > >> > >
> > >> >
> > >>
> > >
> > >
> >
>

Re: [DISCUSS] Asciidoc Header Reformat

[Daniel Kuppitz]

Yea, that was the right regex to look for these errors: grep '^== $'
$(find . -name "*.asciidoc")
Got them all now, will push the fix in a few.

Cheers,
Daniel


On Tue, Sep 26, 2017 at 10:30 AM, Robert Dale  wrote:

> docs/src/reference/gremlin-applications.asciidoc:
> @@ -294,8 +288,7 @@ v[2]
>  v[3]
>  v[4]
>  v[5]
> -v[6]
> -
> +== v[6]
>
>  It is also possible to pass arguments to scripts.  Any parameters
> following the file name specification are treated
>  as arguments to the script. They are collected into a list and passed in
> as a variable called "args".  The following
> @@ -316,8 +309,7 @@ When executed from the command line a parameter can be
> supplied:
>  $ bin/gremlin.sh -e gremlin.groovy marko
>  v[1]
>  $ bin/gremlin.sh -e gremlin.groovy vadas
> -v[2]
> -
> +== v[2]
>
>
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 1:22 PM, Robert Dale  wrote:
>
> > Looks like master CHANGELOG picked up a conflict...
> >
> > <<< HEAD
> > == TinkerPop 3.3.0 (Gremlin Symphony #40 in G Minor)
> > .
> > .
> > .
> >
> > == TinkerPop 3.2.0 (Nine Inch Gremlins)
> > ===
> > == TinkerPop 3.2.0 (Nine Inch Gremlins)
> > >>> asciidoc-header
> >
> >
> > Robert Dale
> >
> > On Tue, Sep 26, 2017 at 1:19 PM, Daniel Kuppitz  wrote:
> >
> >> Ah, good find! That's the same issue I've had in the reference docs and
> >> recipes. Fixed.
> >>
> >> Cheers,
> >> Daniel
> >>
> >>
> >> On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale 
> wrote:
> >>
> >> > git grep "== =="
> >> >
> >> > Robert Dale
> >> >
> >> > On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale 
> wrote:
> >> >
> >> > > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
> >> > > x-incubating.html
> >> > >
> >> > > Robert Dale
> >> > >
> >> > > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale 
> >> wrote:
> >> > >
> >> > >> ^d
> >> > >>
> >> > >> Robert Dale
> >> > >>
> >> > >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz 
> >> > wrote:
> >> > >>
> >> > >>> This is one. I pushed the changes to tp32/ and master/. I only
> found
> >> > (and
> >> > >>> fixed) 2 minor issues, where my script produced a little
> formatting
> >> > mess.
> >> > >>>
> >> > >>> Cheers,
> >> > >>> Daniel
> >> > >>>
> >> > >>>
> >> > >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
> >> > spmalle...@gmail.com>
> >> > >>> wrote:
> >> > >>>
> >> > >>> > For whatever reason we started writing our headers in our docs
> >> with:
> >> > >>> >
> >> > >>> > Header
> >> > >>> > ==
> >> > >>> >
> >> > >>> > Subheader
> >> > >>> > -
> >> > >>> >
> >> > >>> > SubSubHeader
> >> > >>> > 
> >> > >>> >
> >> > >>> > as opposed to the alternative:
> >> > >>> >
> >> > >>> > = This Is A Header
> >> > >>> >
> >> > >>> > == Subheader
> >> > >>> >
> >> > >>> > === SubSubHeader
> >> > >>> >
> >> > >>> > The downside with the first approach is that it forces us to do
> >> two
> >> > >>> things:
> >> > >>> >
> >> > >>> > 1. Remember the syntax for each header layer (which we all
> >> probably
> >> > >>> know
> >> > >>> > pretty well at this point, but still...)
> >> > >>> > 2. Ensure that the width of the header formatting line is equal
> to
> >> > the
> >> > >>> > length of the text above it.
> >> > >>> >
> >> > >>> > That second point is a killer sometimes. While I've trained
> >> myself to
> >> > >>> be
> >> > >>> > good at noticing that problem I know it's bitten us in releases
> >> over
> >> > >>> and
> >> > >>> > over and over again.
> >> > >>> >
> >> > >>> > Anyway, I think going to the alternative formatting would be
> >> better
> >> > and
> >> > >>> > propose to do a full reformatting. Please let me know if there
> are
> >> > any
> >> > >>> > concerns about doing that - if I don't hear back in the next few
> >> days
> >> > >>> I'll
> >> > >>> > proceed with the changes.
> >> > >>> >
> >> > >>> > Thanks,
> >> > >>> >
> >> > >>> > Stephen
> >> > >>> >
> >> > >>>
> >> > >>
> >> > >>
> >> > >
> >> >
> >>
> >
> >
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

That was master.  tp32 is:
@@ -278,8 +272,7 @@ v[2]
 v[3]
 v[4]
 v[5]
-v[6]
-
+== v[6]

 It is also possible to pass arguments to scripts.  Any parameters
following the file name specification are treated
 as arguments to the script. They are collected into a list and passed in
as a variable called "args".  The following
@@ -300,8 +293,7 @@ When executed from the command line a parameter can be
supplied:
 $ bin/gremlin.sh -e gremlin.groovy marko
 v[1]
 $ bin/gremlin.sh -e gremlin.groovy vadas
-v[2]
-
+== v[2]


Robert Dale

On Tue, Sep 26, 2017 at 1:30 PM, Robert Dale  wrote:

> docs/src/reference/gremlin-applications.asciidoc:
> @@ -294,8 +288,7 @@ v[2]
>  v[3]
>  v[4]
>  v[5]
> -v[6]
> -
> +== v[6]
>
>  It is also possible to pass arguments to scripts.  Any parameters
> following the file name specification are treated
>  as arguments to the script. They are collected into a list and passed in
> as a variable called "args".  The following
> @@ -316,8 +309,7 @@ When executed from the command line a parameter can be
> supplied:
>  $ bin/gremlin.sh -e gremlin.groovy marko
>  v[1]
>  $ bin/gremlin.sh -e gremlin.groovy vadas
> -v[2]
> -
> +== v[2]
>
>
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 1:22 PM, Robert Dale  wrote:
>
>> Looks like master CHANGELOG picked up a conflict...
>>
>> <<< HEAD
>> == TinkerPop 3.3.0 (Gremlin Symphony #40 in G Minor)
>> .
>> .
>> .
>>
>> == TinkerPop 3.2.0 (Nine Inch Gremlins)
>> ===
>> == TinkerPop 3.2.0 (Nine Inch Gremlins)
>> >>> asciidoc-header
>>
>>
>> Robert Dale
>>
>> On Tue, Sep 26, 2017 at 1:19 PM, Daniel Kuppitz  wrote:
>>
>>> Ah, good find! That's the same issue I've had in the reference docs and
>>> recipes. Fixed.
>>>
>>> Cheers,
>>> Daniel
>>>
>>>
>>> On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale  wrote:
>>>
>>> > git grep "== =="
>>> >
>>> > Robert Dale
>>> >
>>> > On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale 
>>> wrote:
>>> >
>>> > > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
>>> > > x-incubating.html
>>> > >
>>> > > Robert Dale
>>> > >
>>> > > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale 
>>> wrote:
>>> > >
>>> > >> ^d
>>> > >>
>>> > >> Robert Dale
>>> > >>
>>> > >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz 
>>> > wrote:
>>> > >>
>>> > >>> This is one. I pushed the changes to tp32/ and master/. I only
>>> found
>>> > (and
>>> > >>> fixed) 2 minor issues, where my script produced a little formatting
>>> > mess.
>>> > >>>
>>> > >>> Cheers,
>>> > >>> Daniel
>>> > >>>
>>> > >>>
>>> > >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
>>> > spmalle...@gmail.com>
>>> > >>> wrote:
>>> > >>>
>>> > >>> > For whatever reason we started writing our headers in our docs
>>> with:
>>> > >>> >
>>> > >>> > Header
>>> > >>> > ==
>>> > >>> >
>>> > >>> > Subheader
>>> > >>> > -
>>> > >>> >
>>> > >>> > SubSubHeader
>>> > >>> > 
>>> > >>> >
>>> > >>> > as opposed to the alternative:
>>> > >>> >
>>> > >>> > = This Is A Header
>>> > >>> >
>>> > >>> > == Subheader
>>> > >>> >
>>> > >>> > === SubSubHeader
>>> > >>> >
>>> > >>> > The downside with the first approach is that it forces us to do
>>> two
>>> > >>> things:
>>> > >>> >
>>> > >>> > 1. Remember the syntax for each header layer (which we all
>>> probably
>>> > >>> know
>>> > >>> > pretty well at this point, but still...)
>>> > >>> > 2. Ensure that the width of the header formatting line is equal
>>> to
>>> > the
>>> > >>> > length of the text above it.
>>> > >>> >
>>> > >>> > That second point is a killer sometimes. While I've trained
>>> myself to
>>> > >>> be
>>> > >>> > good at noticing that problem I know it's bitten us in releases
>>> over
>>> > >>> and
>>> > >>> > over and over again.
>>> > >>> >
>>> > >>> > Anyway, I think going to the alternative formatting would be
>>> better
>>> > and
>>> > >>> > propose to do a full reformatting. Please let me know if there
>>> are
>>> > any
>>> > >>> > concerns about doing that - if I don't hear back in the next few
>>> days
>>> > >>> I'll
>>> > >>> > proceed with the changes.
>>> > >>> >
>>> > >>> > Thanks,
>>> > >>> >
>>> > >>> > Stephen
>>> > >>> >
>>> > >>>
>>> > >>
>>> > >>
>>> > >
>>> >
>>>
>>
>>
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

docs/src/reference/gremlin-applications.asciidoc:
@@ -294,8 +288,7 @@ v[2]
 v[3]
 v[4]
 v[5]
-v[6]
-
+== v[6]

 It is also possible to pass arguments to scripts.  Any parameters
following the file name specification are treated
 as arguments to the script. They are collected into a list and passed in
as a variable called "args".  The following
@@ -316,8 +309,7 @@ When executed from the command line a parameter can be
supplied:
 $ bin/gremlin.sh -e gremlin.groovy marko
 v[1]
 $ bin/gremlin.sh -e gremlin.groovy vadas
-v[2]
-
+== v[2]



Robert Dale

On Tue, Sep 26, 2017 at 1:22 PM, Robert Dale  wrote:

> Looks like master CHANGELOG picked up a conflict...
>
> <<< HEAD
> == TinkerPop 3.3.0 (Gremlin Symphony #40 in G Minor)
> .
> .
> .
>
> == TinkerPop 3.2.0 (Nine Inch Gremlins)
> ===
> == TinkerPop 3.2.0 (Nine Inch Gremlins)
> >>> asciidoc-header
>
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 1:19 PM, Daniel Kuppitz  wrote:
>
>> Ah, good find! That's the same issue I've had in the reference docs and
>> recipes. Fixed.
>>
>> Cheers,
>> Daniel
>>
>>
>> On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale  wrote:
>>
>> > git grep "== =="
>> >
>> > Robert Dale
>> >
>> > On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale  wrote:
>> >
>> > > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
>> > > x-incubating.html
>> > >
>> > > Robert Dale
>> > >
>> > > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale 
>> wrote:
>> > >
>> > >> ^d
>> > >>
>> > >> Robert Dale
>> > >>
>> > >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz 
>> > wrote:
>> > >>
>> > >>> This is one. I pushed the changes to tp32/ and master/. I only found
>> > (and
>> > >>> fixed) 2 minor issues, where my script produced a little formatting
>> > mess.
>> > >>>
>> > >>> Cheers,
>> > >>> Daniel
>> > >>>
>> > >>>
>> > >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
>> > spmalle...@gmail.com>
>> > >>> wrote:
>> > >>>
>> > >>> > For whatever reason we started writing our headers in our docs
>> with:
>> > >>> >
>> > >>> > Header
>> > >>> > ==
>> > >>> >
>> > >>> > Subheader
>> > >>> > -
>> > >>> >
>> > >>> > SubSubHeader
>> > >>> > 
>> > >>> >
>> > >>> > as opposed to the alternative:
>> > >>> >
>> > >>> > = This Is A Header
>> > >>> >
>> > >>> > == Subheader
>> > >>> >
>> > >>> > === SubSubHeader
>> > >>> >
>> > >>> > The downside with the first approach is that it forces us to do
>> two
>> > >>> things:
>> > >>> >
>> > >>> > 1. Remember the syntax for each header layer (which we all
>> probably
>> > >>> know
>> > >>> > pretty well at this point, but still...)
>> > >>> > 2. Ensure that the width of the header formatting line is equal to
>> > the
>> > >>> > length of the text above it.
>> > >>> >
>> > >>> > That second point is a killer sometimes. While I've trained
>> myself to
>> > >>> be
>> > >>> > good at noticing that problem I know it's bitten us in releases
>> over
>> > >>> and
>> > >>> > over and over again.
>> > >>> >
>> > >>> > Anyway, I think going to the alternative formatting would be
>> better
>> > and
>> > >>> > propose to do a full reformatting. Please let me know if there are
>> > any
>> > >>> > concerns about doing that - if I don't hear back in the next few
>> days
>> > >>> I'll
>> > >>> > proceed with the changes.
>> > >>> >
>> > >>> > Thanks,
>> > >>> >
>> > >>> > Stephen
>> > >>> >
>> > >>>
>> > >>
>> > >>
>> > >
>> >
>>
>
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

Looks like master CHANGELOG picked up a conflict...

<<< HEAD
== TinkerPop 3.3.0 (Gremlin Symphony #40 in G Minor)
.
.
.

== TinkerPop 3.2.0 (Nine Inch Gremlins)
===
== TinkerPop 3.2.0 (Nine Inch Gremlins)
>>> asciidoc-header


Robert Dale

On Tue, Sep 26, 2017 at 1:19 PM, Daniel Kuppitz  wrote:

> Ah, good find! That's the same issue I've had in the reference docs and
> recipes. Fixed.
>
> Cheers,
> Daniel
>
>
> On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale  wrote:
>
> > git grep "== =="
> >
> > Robert Dale
> >
> > On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale  wrote:
> >
> > > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
> > > x-incubating.html
> > >
> > > Robert Dale
> > >
> > > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale 
> wrote:
> > >
> > >> ^d
> > >>
> > >> Robert Dale
> > >>
> > >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz 
> > wrote:
> > >>
> > >>> This is one. I pushed the changes to tp32/ and master/. I only found
> > (and
> > >>> fixed) 2 minor issues, where my script produced a little formatting
> > mess.
> > >>>
> > >>> Cheers,
> > >>> Daniel
> > >>>
> > >>>
> > >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
> > spmalle...@gmail.com>
> > >>> wrote:
> > >>>
> > >>> > For whatever reason we started writing our headers in our docs
> with:
> > >>> >
> > >>> > Header
> > >>> > ==
> > >>> >
> > >>> > Subheader
> > >>> > -
> > >>> >
> > >>> > SubSubHeader
> > >>> > 
> > >>> >
> > >>> > as opposed to the alternative:
> > >>> >
> > >>> > = This Is A Header
> > >>> >
> > >>> > == Subheader
> > >>> >
> > >>> > === SubSubHeader
> > >>> >
> > >>> > The downside with the first approach is that it forces us to do two
> > >>> things:
> > >>> >
> > >>> > 1. Remember the syntax for each header layer (which we all probably
> > >>> know
> > >>> > pretty well at this point, but still...)
> > >>> > 2. Ensure that the width of the header formatting line is equal to
> > the
> > >>> > length of the text above it.
> > >>> >
> > >>> > That second point is a killer sometimes. While I've trained myself
> to
> > >>> be
> > >>> > good at noticing that problem I know it's bitten us in releases
> over
> > >>> and
> > >>> > over and over again.
> > >>> >
> > >>> > Anyway, I think going to the alternative formatting would be better
> > and
> > >>> > propose to do a full reformatting. Please let me know if there are
> > any
> > >>> > concerns about doing that - if I don't hear back in the next few
> days
> > >>> I'll
> > >>> > proceed with the changes.
> > >>> >
> > >>> > Thanks,
> > >>> >
> > >>> > Stephen
> > >>> >
> > >>>
> > >>
> > >>
> > >
> >
>

Re: [DISCUSS] Asciidoc Header Reformat

[Daniel Kuppitz]

Ah, good find! That's the same issue I've had in the reference docs and
recipes. Fixed.

Cheers,
Daniel


On Tue, Sep 26, 2017 at 10:08 AM, Robert Dale  wrote:

> git grep "== =="
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale  wrote:
>
> > I see things like '== ==>6' in docs/src/upgrade/release-3.2.
> > x-incubating.html
> >
> > Robert Dale
> >
> > On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale  wrote:
> >
> >> ^d
> >>
> >> Robert Dale
> >>
> >> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz 
> wrote:
> >>
> >>> This is one. I pushed the changes to tp32/ and master/. I only found
> (and
> >>> fixed) 2 minor issues, where my script produced a little formatting
> mess.
> >>>
> >>> Cheers,
> >>> Daniel
> >>>
> >>>
> >>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette <
> spmalle...@gmail.com>
> >>> wrote:
> >>>
> >>> > For whatever reason we started writing our headers in our docs with:
> >>> >
> >>> > Header
> >>> > ==
> >>> >
> >>> > Subheader
> >>> > -
> >>> >
> >>> > SubSubHeader
> >>> > 
> >>> >
> >>> > as opposed to the alternative:
> >>> >
> >>> > = This Is A Header
> >>> >
> >>> > == Subheader
> >>> >
> >>> > === SubSubHeader
> >>> >
> >>> > The downside with the first approach is that it forces us to do two
> >>> things:
> >>> >
> >>> > 1. Remember the syntax for each header layer (which we all probably
> >>> know
> >>> > pretty well at this point, but still...)
> >>> > 2. Ensure that the width of the header formatting line is equal to
> the
> >>> > length of the text above it.
> >>> >
> >>> > That second point is a killer sometimes. While I've trained myself to
> >>> be
> >>> > good at noticing that problem I know it's bitten us in releases over
> >>> and
> >>> > over and over again.
> >>> >
> >>> > Anyway, I think going to the alternative formatting would be better
> and
> >>> > propose to do a full reformatting. Please let me know if there are
> any
> >>> > concerns about doing that - if I don't hear back in the next few days
> >>> I'll
> >>> > proceed with the changes.
> >>> >
> >>> > Thanks,
> >>> >
> >>> > Stephen
> >>> >
> >>>
> >>
> >>
> >
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

git grep "== =="

Robert Dale

On Tue, Sep 26, 2017 at 1:07 PM, Robert Dale  wrote:

> I see things like '== ==>6' in docs/src/upgrade/release-3.2.
> x-incubating.html
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale  wrote:
>
>> ^d
>>
>> Robert Dale
>>
>> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz  wrote:
>>
>>> This is one. I pushed the changes to tp32/ and master/. I only found (and
>>> fixed) 2 minor issues, where my script produced a little formatting mess.
>>>
>>> Cheers,
>>> Daniel
>>>
>>>
>>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette 
>>> wrote:
>>>
>>> > For whatever reason we started writing our headers in our docs with:
>>> >
>>> > Header
>>> > ==
>>> >
>>> > Subheader
>>> > -
>>> >
>>> > SubSubHeader
>>> > 
>>> >
>>> > as opposed to the alternative:
>>> >
>>> > = This Is A Header
>>> >
>>> > == Subheader
>>> >
>>> > === SubSubHeader
>>> >
>>> > The downside with the first approach is that it forces us to do two
>>> things:
>>> >
>>> > 1. Remember the syntax for each header layer (which we all probably
>>> know
>>> > pretty well at this point, but still...)
>>> > 2. Ensure that the width of the header formatting line is equal to the
>>> > length of the text above it.
>>> >
>>> > That second point is a killer sometimes. While I've trained myself to
>>> be
>>> > good at noticing that problem I know it's bitten us in releases over
>>> and
>>> > over and over again.
>>> >
>>> > Anyway, I think going to the alternative formatting would be better and
>>> > propose to do a full reformatting. Please let me know if there are any
>>> > concerns about doing that - if I don't hear back in the next few days
>>> I'll
>>> > proceed with the changes.
>>> >
>>> > Thanks,
>>> >
>>> > Stephen
>>> >
>>>
>>
>>
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

I see things like '== ==>6' in
docs/src/upgrade/release-3.2.x-incubating.html

Robert Dale

On Tue, Sep 26, 2017 at 12:57 PM, Robert Dale  wrote:

> ^d
>
> Robert Dale
>
> On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz  wrote:
>
>> This is one. I pushed the changes to tp32/ and master/. I only found (and
>> fixed) 2 minor issues, where my script produced a little formatting mess.
>>
>> Cheers,
>> Daniel
>>
>>
>> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette 
>> wrote:
>>
>> > For whatever reason we started writing our headers in our docs with:
>> >
>> > Header
>> > ==
>> >
>> > Subheader
>> > -
>> >
>> > SubSubHeader
>> > 
>> >
>> > as opposed to the alternative:
>> >
>> > = This Is A Header
>> >
>> > == Subheader
>> >
>> > === SubSubHeader
>> >
>> > The downside with the first approach is that it forces us to do two
>> things:
>> >
>> > 1. Remember the syntax for each header layer (which we all probably know
>> > pretty well at this point, but still...)
>> > 2. Ensure that the width of the header formatting line is equal to the
>> > length of the text above it.
>> >
>> > That second point is a killer sometimes. While I've trained myself to be
>> > good at noticing that problem I know it's bitten us in releases over and
>> > over and over again.
>> >
>> > Anyway, I think going to the alternative formatting would be better and
>> > propose to do a full reformatting. Please let me know if there are any
>> > concerns about doing that - if I don't hear back in the next few days
>> I'll
>> > proceed with the changes.
>> >
>> > Thanks,
>> >
>> > Stephen
>> >
>>
>
>

Re: [DISCUSS] Asciidoc Header Reformat

[Robert Dale]

^d

Robert Dale

On Tue, Sep 26, 2017 at 12:56 PM, Daniel Kuppitz  wrote:

> This is one. I pushed the changes to tp32/ and master/. I only found (and
> fixed) 2 minor issues, where my script produced a little formatting mess.
>
> Cheers,
> Daniel
>
>
> On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette 
> wrote:
>
> > For whatever reason we started writing our headers in our docs with:
> >
> > Header
> > ==
> >
> > Subheader
> > -
> >
> > SubSubHeader
> > 
> >
> > as opposed to the alternative:
> >
> > = This Is A Header
> >
> > == Subheader
> >
> > === SubSubHeader
> >
> > The downside with the first approach is that it forces us to do two
> things:
> >
> > 1. Remember the syntax for each header layer (which we all probably know
> > pretty well at this point, but still...)
> > 2. Ensure that the width of the header formatting line is equal to the
> > length of the text above it.
> >
> > That second point is a killer sometimes. While I've trained myself to be
> > good at noticing that problem I know it's bitten us in releases over and
> > over and over again.
> >
> > Anyway, I think going to the alternative formatting would be better and
> > propose to do a full reformatting. Please let me know if there are any
> > concerns about doing that - if I don't hear back in the next few days
> I'll
> > proceed with the changes.
> >
> > Thanks,
> >
> > Stephen
> >
>

Re: [DISCUSS] Asciidoc Header Reformat

[Daniel Kuppitz]

This is one. I pushed the changes to tp32/ and master/. I only found (and
fixed) 2 minor issues, where my script produced a little formatting mess.

Cheers,
Daniel


On Tue, Sep 19, 2017 at 9:23 AM, Stephen Mallette 
wrote:

> For whatever reason we started writing our headers in our docs with:
>
> Header
> ==
>
> Subheader
> -
>
> SubSubHeader
> 
>
> as opposed to the alternative:
>
> = This Is A Header
>
> == Subheader
>
> === SubSubHeader
>
> The downside with the first approach is that it forces us to do two things:
>
> 1. Remember the syntax for each header layer (which we all probably know
> pretty well at this point, but still...)
> 2. Ensure that the width of the header formatting line is equal to the
> length of the text above it.
>
> That second point is a killer sometimes. While I've trained myself to be
> good at noticing that problem I know it's bitten us in releases over and
> over and over again.
>
> Anyway, I think going to the alternative formatting would be better and
> propose to do a full reformatting. Please let me know if there are any
> concerns about doing that - if I don't hear back in the next few days I'll
> proceed with the changes.
>
> Thanks,
>
> Stephen
>

Re: [DISCUSS] Asciidoc Header Reformat

[Misha Brukman]

I ran into this problem previously as well; it's also interesting that the
build will break if the length of the heading is much longer/shorter than
the length of the underline (I think a difference of more than 2 characters
causes a build error).

Here is a Python and shell script I wrote to do the fix for an entire repo:

#!/usr/bin/python

import re
import sys

def main(argv):
# http://asciidoctor.org/docs/asciidoc-recommended-practices/#section-titles
patterns = [
(re.compile('^=+$'), '='),
(re.compile('^-+$'), '=='),
(re.compile('^~+$'), '==='),
(re.compile('^\^+$'), ''),
(re.compile('^\++$'), '='),
]

with open(argv[1], 'r') as input_file:
prev_line = None
curr_line = None
for line in input_file.readlines():
prev_line = curr_line
curr_line = line

if prev_line is None:
continue

for pattern, heading in patterns:
if pattern.match(curr_line) and len(prev_line) ==
len(curr_line):
sys.stdout.write('%s %s' % (heading, prev_line))
prev_line = None
curr_line = None
break

if prev_line is not None:
sys.stdout.write(prev_line)

# end for
if curr_line is not None:
sys.stdout.write(curr_line)

# end with

if __name__ == '__main__':
main(sys.argv)


and here's a shell script driver:

#!/bin/bash

tmp="$(mktemp /tmp/asciidoc-cleanup.XX)"
for file in *.txt ; do
  ./asciidoc.py $file > $tmp
  if [[ $? == 0 ]]; then
mv $tmp $file
  else
echo "error in $file" >&2
  fi
done


YMMV, etc.

Hope this helps!

On Tue, Sep 19, 2017 at 12:23 PM, Stephen Mallette 
wrote:

> For whatever reason we started writing our headers in our docs with:
>
> Header
> ==
>
> Subheader
> -
>
> SubSubHeader
> 
>
> as opposed to the alternative:
>
> = This Is A Header
>
> == Subheader
>
> === SubSubHeader
>
> The downside with the first approach is that it forces us to do two things:
>
> 1. Remember the syntax for each header layer (which we all probably know
> pretty well at this point, but still...)
> 2. Ensure that the width of the header formatting line is equal to the
> length of the text above it.
>
> That second point is a killer sometimes. While I've trained myself to be
> good at noticing that problem I know it's bitten us in releases over and
> over and over again.
>
> Anyway, I think going to the alternative formatting would be better and
> propose to do a full reformatting. Please let me know if there are any
> concerns about doing that - if I don't hear back in the next few days I'll
> proceed with the changes.
>
> Thanks,
>
> Stephen
>