You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Claude Warren <cl...@xenei.com> on 2024/10/02 07:38:33 UTC
Re: [CLI] [DISCUSS] Help formatter extension proposal
Not hearing any other ideas and even though I prefer "Scribe" I will rename
the class to "HelpWriter".
Thanks everyone for your input.
On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net> wrote:
> My vote (which everyone is free to ignore) is still for HelpWriter. It's
> simple and intuitive, and it's consistent with the names of the methods the
> interface declares (e.g. writePara, writeTable). I
> find SemanticAppendableDecorator too verbose and I have no intuition for
> what it means.
>
> Peter
>
> On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com> wrote:
>
> > If we can settle on a name for the
> > serializer/scribe/writer/printDecorator/amenuensis thing the rest of the
> > code is ready. It passes all the tests, it has 100% test coverage, and
> it
> > works for what Rat is trying to do.
> >
> >
> > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <cl...@xenei.com> wrote:
> >
> > > I have opened https://github.com/apache/commons-cli/pull/314 to track
> > the
> > > proposed changes
> > >
> > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <cl...@xenei.com>
> wrote:
> > >
> > >> I know some graphics programs use the term "engraver" for code that
> > >> creates the output of graphical representations of things (like notes,
> > >> staves, and resets in musical notation). Scribe seems like the
> textual
> > >> equivalent.
> > >>
> > >> If we go with the decorator approach then I think the underlying
> > >> interface should be SemanticAppendableDecorator.
> > >>
> > >>
> > >> - Semantic because it describes what to do with the semantic terms
> > >> like "paragraph", "header", and "list".
> > >> - Appendable because that is what is wraps.
> > >> - Decorator because that is what it does.
> > >>
> > >>
> > >>
> > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <gilleseran@gmail.com
> >
> > >> wrote:
> > >>
> > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <ga...@gmail.com>
> a
> > >>> écrit :
> > >>> >
> > >>> > It's pretty unusual IMO, not like anything in the JDK for example.
> > >>>
> > >>> Agreed.
> > >>>
> > >>> > I'll see
> > >>> > if I can come up with something tomorrow...
> > >>>
> > >>> How about "PrintDecorator" ?
> > >>>
> > >>> Gilles
> > >>>
> > >>> >>> [...]
> > >>>
> > >>> ---------------------------------------------------------------------
> > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > >>> For additional commands, e-mail: dev-help@commons.apache.org
> > >>>
> > >>>
> > >>
> > >> --
> > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > >>
> > >
> > >
> > > --
> > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > >
> >
> >
> > --
> > LinkedIn: http://www.linkedin.com/in/claudewarren
> >
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Gary Gregory <ga...@gmail.com>.
Hi Eric,
TextStyle and TextHelpAppenndable carry widths.
HTH,
Gary
On Tue, Nov 12, 2024, 7:43 AM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> Working through it… I am hoping to be able to contribute a
> AsciiDocAppendable.
>
> So, here is a question.. How do I set the Width?
> HelpFormatter.setWidth() has gone away, and I can’t quite track where it
> went!
>
>
> > On Nov 10, 2024, at 10:36 AM, Gary Gregory <ga...@gmail.com>
> wrote:
> >
> > Let me know and feel free to create a PR.
> >
> > I can cut a release candidate whenever you are ready.
> >
> > Gary
> >
> > On Sun, Nov 10, 2024, 7:23 AM Eric Pugh <epugh@opensourceconnections.com
> >
> > wrote:
> >
> >> I am starting to poke at the CLI-339 feature.. Looking at the PR,
> >>
> >>
> https://github.com/apache/commons-cli/pull/314/files#diff-c5837d81e3e4f87d5222b1d8caa45c9c9cd2c6edff6ad31e3a0b603f0b64d389
> >> ,
> >> I see the code... I am not quite seeing the big picture however...
> I
> >> am hoping to see some docs on "How to use the new Help Formatter
> >> extensions"...
> >>
> >> It does seem like JavaDocs are our primary documentation format over the
> >> website usage.html page...
> >>
> >> I'm hoping to confirm that what Claude wrote (thank you!!) works the
> way we
> >> want it to before 1.10 goes out!
> >>
> >> On Fri, Oct 4, 2024 at 12:56 PM Claude Warren <cl...@xenei.com> wrote:
> >>
> >>> Thx Gary. I will review this weekend.
> >>>
> >>> On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
> >>>
> >>>> Hi all,
> >>>>
> >>>> I wrote a bunch of comments in the PR.
> >>>>
> >>>> Gary
> >>>>
> >>>> On 2024/10/02 10:57:53 Tushar Kapila wrote:
> >>>>> I don't contribute code. But looking at the dictionary meaning Scribe
> >>>> fits.
> >>>>> So my vote is Scribe.
> >>>>>
> >>>>> a word that fits and not confused with existing class/
> >> responsibility?
> >>>>>
> >>>>> verb
> >>>>> 1.
> >>>>> literary
> >>>>> write.
> >>>>> "he scribed a note that he passed to Dan"
> >>>>>
> >>>>> On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com>
> >>> wrote:
> >>>>>
> >>>>>> Sorry about that, I'll have a look today or tomorrow.
> >>>>>>
> >>>>>> Gary
> >>>>>>
> >>>>>> On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com>
> >> wrote:
> >>>>>>
> >>>>>>> Not hearing any other ideas and even though I prefer "Scribe" I
> >>> will
> >>>>>> rename
> >>>>>>> the class to "HelpWriter".
> >>>>>>>
> >>>>>>> Thanks everyone for your input.
> >>>>>>>
> >>>>>>> On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net>
> >>> wrote:
> >>>>>>>
> >>>>>>>> My vote (which everyone is free to ignore) is still for
> >>> HelpWriter.
> >>>>>> It's
> >>>>>>>> simple and intuitive, and it's consistent with the names of the
> >>>> methods
> >>>>>>> the
> >>>>>>>> interface declares (e.g. writePara, writeTable). I
> >>>>>>>> find SemanticAppendableDecorator too verbose and I have no
> >>>> intuition
> >>>>>> for
> >>>>>>>> what it means.
> >>>>>>>>
> >>>>>>>> Peter
> >>>>>>>>
> >>>>>>>> On Mon, Sep 30, 2024, 12:31 PM Claude Warren <claude@xenei.com
> >>>
> >>>> wrote:
> >>>>>>>>
> >>>>>>>>> If we can settle on a name for the
> >>>>>>>>> serializer/scribe/writer/printDecorator/amenuensis thing the
> >>>> rest of
> >>>>>>> the
> >>>>>>>>> code is ready. It passes all the tests, it has 100% test
> >>>> coverage,
> >>>>>>> and
> >>>>>>>> it
> >>>>>>>>> works for what Rat is trying to do.
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>>> On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <
> >>> claude@xenei.com>
> >>>>>>> wrote:
> >>>>>>>>>
> >>>>>>>>>> I have opened
> >> https://github.com/apache/commons-cli/pull/314
> >>>> to
> >>>>>>> track
> >>>>>>>>> the
> >>>>>>>>>> proposed changes
> >>>>>>>>>>
> >>>>>>>>>> On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
> >>>> claude@xenei.com>
> >>>>>>>> wrote:
> >>>>>>>>>>
> >>>>>>>>>>> I know some graphics programs use the term "engraver" for
> >>> code
> >>>>>> that
> >>>>>>>>>>> creates the output of graphical representations of things
> >>>> (like
> >>>>>>> notes,
> >>>>>>>>>>> staves, and resets in musical notation). Scribe seems
> >> like
> >>>> the
> >>>>>>>> textual
> >>>>>>>>>>> equivalent.
> >>>>>>>>>>>
> >>>>>>>>>>> If we go with the decorator approach then I think the
> >>>> underlying
> >>>>>>>>>>> interface should be SemanticAppendableDecorator.
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> - Semantic because it describes what to do with the
> >>>> semantic
> >>>>>>> terms
> >>>>>>>>>>> like "paragraph", "header", and "list".
> >>>>>>>>>>> - Appendable because that is what is wraps.
> >>>>>>>>>>> - Decorator because that is what it does.
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> >>>>>>> gilleseran@gmail.com
> >>>>>>>>>
> >>>>>>>>>>> wrote:
> >>>>>>>>>>>
> >>>>>>>>>>>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> >>>>>>> garydgregory@gmail.com>
> >>>>>>>> a
> >>>>>>>>>>>> écrit :
> >>>>>>>>>>>>>
> >>>>>>>>>>>>> It's pretty unusual IMO, not like anything in the JDK
> >> for
> >>>>>>> example.
> >>>>>>>>>>>>
> >>>>>>>>>>>> Agreed.
> >>>>>>>>>>>>
> >>>>>>>>>>>>> I'll see
> >>>>>>>>>>>>> if I can come up with something tomorrow...
> >>>>>>>>>>>>
> >>>>>>>>>>>> How about "PrintDecorator" ?
> >>>>>>>>>>>>
> >>>>>>>>>>>> Gilles
> >>>>>>>>>>>>
> >>>>>>>>>>>>>>> [...]
> >>>>>>>>>>>>
> >>>>>>>>>>>>
> >>>>>>>
> >>> ---------------------------------------------------------------------
> >>>>>>>>>>>> To unsubscribe, e-mail:
> >> dev-unsubscribe@commons.apache.org
> >>>>>>>>>>>> For additional commands, e-mail:
> >>> dev-help@commons.apache.org
> >>>>>>>>>>>>
> >>>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> --
> >>>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>>>
> >>>>>>>>>>
> >>>>>>>>>>
> >>>>>>>>>> --
> >>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>>
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>>> --
> >>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>
> >>>>>>>>
> >>>>>>>
> >>>>>>>
> >>>>>>> --
> >>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>
> >>>>>>
> >>>>>
> >>>>
> >>>> ---------------------------------------------------------------------
> >>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >>>> For additional commands, e-mail: dev-help@commons.apache.org
> >>>>
> >>>>
> >>>
> >>
>
> _______________________
> Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 |
> http://www.opensourceconnections.com <
> http://www.opensourceconnections.com/> | My Free/Busy <
> http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <
> https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless of
> whether attachments are marked as such.
>
>
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Claude Warren <cl...@xenei.com>.
Width is set in the TextStyle and (potentially) in the Appendable.
The TextStyle specifies for the specific chunk of code what the requested
size is. The Appendable can ignore that or make adjustments to it. This
is seen in the TextHelpAppendable.appendTable() method where the specified
columns for the table may be adjusted to fit the page width. If
AsciiDocAppendable has the concept of width then look to the
TextHelpAppendable for examples.
Some Appendables may choose not to specify a width (e.g. XHTML for example,
though it may also create CSS inline or something similar with the width
information).
AlmostPlainText doesn't have any with controls that I could find, nor does
markdown so they would ignore the width settings.
I hope this makes sense,
Claude
On Tue, Nov 12, 2024 at 12:43 PM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> Working through it… I am hoping to be able to contribute a
> AsciiDocAppendable.
>
> So, here is a question.. How do I set the Width?
> HelpFormatter.setWidth() has gone away, and I can’t quite track where it
> went!
>
>
> > On Nov 10, 2024, at 10:36 AM, Gary Gregory <ga...@gmail.com>
> wrote:
> >
> > Let me know and feel free to create a PR.
> >
> > I can cut a release candidate whenever you are ready.
> >
> > Gary
> >
> > On Sun, Nov 10, 2024, 7:23 AM Eric Pugh <epugh@opensourceconnections.com
> >
> > wrote:
> >
> >> I am starting to poke at the CLI-339 feature.. Looking at the PR,
> >>
> >>
> https://github.com/apache/commons-cli/pull/314/files#diff-c5837d81e3e4f87d5222b1d8caa45c9c9cd2c6edff6ad31e3a0b603f0b64d389
> >> ,
> >> I see the code... I am not quite seeing the big picture however...
> I
> >> am hoping to see some docs on "How to use the new Help Formatter
> >> extensions"...
> >>
> >> It does seem like JavaDocs are our primary documentation format over the
> >> website usage.html page...
> >>
> >> I'm hoping to confirm that what Claude wrote (thank you!!) works the
> way we
> >> want it to before 1.10 goes out!
> >>
> >> On Fri, Oct 4, 2024 at 12:56 PM Claude Warren <cl...@xenei.com> wrote:
> >>
> >>> Thx Gary. I will review this weekend.
> >>>
> >>> On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
> >>>
> >>>> Hi all,
> >>>>
> >>>> I wrote a bunch of comments in the PR.
> >>>>
> >>>> Gary
> >>>>
> >>>> On 2024/10/02 10:57:53 Tushar Kapila wrote:
> >>>>> I don't contribute code. But looking at the dictionary meaning Scribe
> >>>> fits.
> >>>>> So my vote is Scribe.
> >>>>>
> >>>>> a word that fits and not confused with existing class/
> >> responsibility?
> >>>>>
> >>>>> verb
> >>>>> 1.
> >>>>> literary
> >>>>> write.
> >>>>> "he scribed a note that he passed to Dan"
> >>>>>
> >>>>> On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com>
> >>> wrote:
> >>>>>
> >>>>>> Sorry about that, I'll have a look today or tomorrow.
> >>>>>>
> >>>>>> Gary
> >>>>>>
> >>>>>> On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com>
> >> wrote:
> >>>>>>
> >>>>>>> Not hearing any other ideas and even though I prefer "Scribe" I
> >>> will
> >>>>>> rename
> >>>>>>> the class to "HelpWriter".
> >>>>>>>
> >>>>>>> Thanks everyone for your input.
> >>>>>>>
> >>>>>>> On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net>
> >>> wrote:
> >>>>>>>
> >>>>>>>> My vote (which everyone is free to ignore) is still for
> >>> HelpWriter.
> >>>>>> It's
> >>>>>>>> simple and intuitive, and it's consistent with the names of the
> >>>> methods
> >>>>>>> the
> >>>>>>>> interface declares (e.g. writePara, writeTable). I
> >>>>>>>> find SemanticAppendableDecorator too verbose and I have no
> >>>> intuition
> >>>>>> for
> >>>>>>>> what it means.
> >>>>>>>>
> >>>>>>>> Peter
> >>>>>>>>
> >>>>>>>> On Mon, Sep 30, 2024, 12:31 PM Claude Warren <claude@xenei.com
> >>>
> >>>> wrote:
> >>>>>>>>
> >>>>>>>>> If we can settle on a name for the
> >>>>>>>>> serializer/scribe/writer/printDecorator/amenuensis thing the
> >>>> rest of
> >>>>>>> the
> >>>>>>>>> code is ready. It passes all the tests, it has 100% test
> >>>> coverage,
> >>>>>>> and
> >>>>>>>> it
> >>>>>>>>> works for what Rat is trying to do.
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>>> On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <
> >>> claude@xenei.com>
> >>>>>>> wrote:
> >>>>>>>>>
> >>>>>>>>>> I have opened
> >> https://github.com/apache/commons-cli/pull/314
> >>>> to
> >>>>>>> track
> >>>>>>>>> the
> >>>>>>>>>> proposed changes
> >>>>>>>>>>
> >>>>>>>>>> On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
> >>>> claude@xenei.com>
> >>>>>>>> wrote:
> >>>>>>>>>>
> >>>>>>>>>>> I know some graphics programs use the term "engraver" for
> >>> code
> >>>>>> that
> >>>>>>>>>>> creates the output of graphical representations of things
> >>>> (like
> >>>>>>> notes,
> >>>>>>>>>>> staves, and resets in musical notation). Scribe seems
> >> like
> >>>> the
> >>>>>>>> textual
> >>>>>>>>>>> equivalent.
> >>>>>>>>>>>
> >>>>>>>>>>> If we go with the decorator approach then I think the
> >>>> underlying
> >>>>>>>>>>> interface should be SemanticAppendableDecorator.
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> - Semantic because it describes what to do with the
> >>>> semantic
> >>>>>>> terms
> >>>>>>>>>>> like "paragraph", "header", and "list".
> >>>>>>>>>>> - Appendable because that is what is wraps.
> >>>>>>>>>>> - Decorator because that is what it does.
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> >>>>>>> gilleseran@gmail.com
> >>>>>>>>>
> >>>>>>>>>>> wrote:
> >>>>>>>>>>>
> >>>>>>>>>>>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> >>>>>>> garydgregory@gmail.com>
> >>>>>>>> a
> >>>>>>>>>>>> écrit :
> >>>>>>>>>>>>>
> >>>>>>>>>>>>> It's pretty unusual IMO, not like anything in the JDK
> >> for
> >>>>>>> example.
> >>>>>>>>>>>>
> >>>>>>>>>>>> Agreed.
> >>>>>>>>>>>>
> >>>>>>>>>>>>> I'll see
> >>>>>>>>>>>>> if I can come up with something tomorrow...
> >>>>>>>>>>>>
> >>>>>>>>>>>> How about "PrintDecorator" ?
> >>>>>>>>>>>>
> >>>>>>>>>>>> Gilles
> >>>>>>>>>>>>
> >>>>>>>>>>>>>>> [...]
> >>>>>>>>>>>>
> >>>>>>>>>>>>
> >>>>>>>
> >>> ---------------------------------------------------------------------
> >>>>>>>>>>>> To unsubscribe, e-mail:
> >> dev-unsubscribe@commons.apache.org
> >>>>>>>>>>>> For additional commands, e-mail:
> >>> dev-help@commons.apache.org
> >>>>>>>>>>>>
> >>>>>>>>>>>>
> >>>>>>>>>>>
> >>>>>>>>>>> --
> >>>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>>>
> >>>>>>>>>>
> >>>>>>>>>>
> >>>>>>>>>> --
> >>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>>
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>>> --
> >>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>>>
> >>>>>>>>
> >>>>>>>
> >>>>>>>
> >>>>>>> --
> >>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
> >>>>>>>
> >>>>>>
> >>>>>
> >>>>
> >>>> ---------------------------------------------------------------------
> >>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >>>> For additional commands, e-mail: dev-help@commons.apache.org
> >>>>
> >>>>
> >>>
> >>
>
> _______________________
> Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 |
> http://www.opensourceconnections.com <
> http://www.opensourceconnections.com/> | My Free/Busy <
> http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <
> https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless of
> whether attachments are marked as such.
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Eric Pugh <ep...@opensourceconnections.com>.
Working through it… I am hoping to be able to contribute a AsciiDocAppendable.
So, here is a question.. How do I set the Width? HelpFormatter.setWidth() has gone away, and I can’t quite track where it went!
> On Nov 10, 2024, at 10:36 AM, Gary Gregory <ga...@gmail.com> wrote:
>
> Let me know and feel free to create a PR.
>
> I can cut a release candidate whenever you are ready.
>
> Gary
>
> On Sun, Nov 10, 2024, 7:23 AM Eric Pugh <ep...@opensourceconnections.com>
> wrote:
>
>> I am starting to poke at the CLI-339 feature.. Looking at the PR,
>>
>> https://github.com/apache/commons-cli/pull/314/files#diff-c5837d81e3e4f87d5222b1d8caa45c9c9cd2c6edff6ad31e3a0b603f0b64d389
>> ,
>> I see the code... I am not quite seeing the big picture however... I
>> am hoping to see some docs on "How to use the new Help Formatter
>> extensions"...
>>
>> It does seem like JavaDocs are our primary documentation format over the
>> website usage.html page...
>>
>> I'm hoping to confirm that what Claude wrote (thank you!!) works the way we
>> want it to before 1.10 goes out!
>>
>> On Fri, Oct 4, 2024 at 12:56 PM Claude Warren <cl...@xenei.com> wrote:
>>
>>> Thx Gary. I will review this weekend.
>>>
>>> On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
>>>
>>>> Hi all,
>>>>
>>>> I wrote a bunch of comments in the PR.
>>>>
>>>> Gary
>>>>
>>>> On 2024/10/02 10:57:53 Tushar Kapila wrote:
>>>>> I don't contribute code. But looking at the dictionary meaning Scribe
>>>> fits.
>>>>> So my vote is Scribe.
>>>>>
>>>>> a word that fits and not confused with existing class/
>> responsibility?
>>>>>
>>>>> verb
>>>>> 1.
>>>>> literary
>>>>> write.
>>>>> "he scribed a note that he passed to Dan"
>>>>>
>>>>> On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com>
>>> wrote:
>>>>>
>>>>>> Sorry about that, I'll have a look today or tomorrow.
>>>>>>
>>>>>> Gary
>>>>>>
>>>>>> On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com>
>> wrote:
>>>>>>
>>>>>>> Not hearing any other ideas and even though I prefer "Scribe" I
>>> will
>>>>>> rename
>>>>>>> the class to "HelpWriter".
>>>>>>>
>>>>>>> Thanks everyone for your input.
>>>>>>>
>>>>>>> On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net>
>>> wrote:
>>>>>>>
>>>>>>>> My vote (which everyone is free to ignore) is still for
>>> HelpWriter.
>>>>>> It's
>>>>>>>> simple and intuitive, and it's consistent with the names of the
>>>> methods
>>>>>>> the
>>>>>>>> interface declares (e.g. writePara, writeTable). I
>>>>>>>> find SemanticAppendableDecorator too verbose and I have no
>>>> intuition
>>>>>> for
>>>>>>>> what it means.
>>>>>>>>
>>>>>>>> Peter
>>>>>>>>
>>>>>>>> On Mon, Sep 30, 2024, 12:31 PM Claude Warren <claude@xenei.com
>>>
>>>> wrote:
>>>>>>>>
>>>>>>>>> If we can settle on a name for the
>>>>>>>>> serializer/scribe/writer/printDecorator/amenuensis thing the
>>>> rest of
>>>>>>> the
>>>>>>>>> code is ready. It passes all the tests, it has 100% test
>>>> coverage,
>>>>>>> and
>>>>>>>> it
>>>>>>>>> works for what Rat is trying to do.
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <
>>> claude@xenei.com>
>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> I have opened
>> https://github.com/apache/commons-cli/pull/314
>>>> to
>>>>>>> track
>>>>>>>>> the
>>>>>>>>>> proposed changes
>>>>>>>>>>
>>>>>>>>>> On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
>>>> claude@xenei.com>
>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> I know some graphics programs use the term "engraver" for
>>> code
>>>>>> that
>>>>>>>>>>> creates the output of graphical representations of things
>>>> (like
>>>>>>> notes,
>>>>>>>>>>> staves, and resets in musical notation). Scribe seems
>> like
>>>> the
>>>>>>>> textual
>>>>>>>>>>> equivalent.
>>>>>>>>>>>
>>>>>>>>>>> If we go with the decorator approach then I think the
>>>> underlying
>>>>>>>>>>> interface should be SemanticAppendableDecorator.
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> - Semantic because it describes what to do with the
>>>> semantic
>>>>>>> terms
>>>>>>>>>>> like "paragraph", "header", and "list".
>>>>>>>>>>> - Appendable because that is what is wraps.
>>>>>>>>>>> - Decorator because that is what it does.
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
>>>>>>> gilleseran@gmail.com
>>>>>>>>>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
>>>>>>> garydgregory@gmail.com>
>>>>>>>> a
>>>>>>>>>>>> écrit :
>>>>>>>>>>>>>
>>>>>>>>>>>>> It's pretty unusual IMO, not like anything in the JDK
>> for
>>>>>>> example.
>>>>>>>>>>>>
>>>>>>>>>>>> Agreed.
>>>>>>>>>>>>
>>>>>>>>>>>>> I'll see
>>>>>>>>>>>>> if I can come up with something tomorrow...
>>>>>>>>>>>>
>>>>>>>>>>>> How about "PrintDecorator" ?
>>>>>>>>>>>>
>>>>>>>>>>>> Gilles
>>>>>>>>>>>>
>>>>>>>>>>>>>>> [...]
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>
>>> ---------------------------------------------------------------------
>>>>>>>>>>>> To unsubscribe, e-mail:
>> dev-unsubscribe@commons.apache.org
>>>>>>>>>>>> For additional commands, e-mail:
>>> dev-help@commons.apache.org
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> --
>>>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
>>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
>>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> --
>>>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
>>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> LinkedIn: http://www.linkedin.com/in/claudewarren
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>>
>>>>
>>>
>>
_______________________
Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | My Free/Busy <http://tinyurl.com/eric-cal>
Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Gary Gregory <ga...@gmail.com>.
Let me know and feel free to create a PR.
I can cut a release candidate whenever you are ready.
Gary
On Sun, Nov 10, 2024, 7:23 AM Eric Pugh <ep...@opensourceconnections.com>
wrote:
> I am starting to poke at the CLI-339 feature.. Looking at the PR,
>
> https://github.com/apache/commons-cli/pull/314/files#diff-c5837d81e3e4f87d5222b1d8caa45c9c9cd2c6edff6ad31e3a0b603f0b64d389
> ,
> I see the code... I am not quite seeing the big picture however... I
> am hoping to see some docs on "How to use the new Help Formatter
> extensions"...
>
> It does seem like JavaDocs are our primary documentation format over the
> website usage.html page...
>
> I'm hoping to confirm that what Claude wrote (thank you!!) works the way we
> want it to before 1.10 goes out!
>
> On Fri, Oct 4, 2024 at 12:56 PM Claude Warren <cl...@xenei.com> wrote:
>
> > Thx Gary. I will review this weekend.
> >
> > On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
> >
> > > Hi all,
> > >
> > > I wrote a bunch of comments in the PR.
> > >
> > > Gary
> > >
> > > On 2024/10/02 10:57:53 Tushar Kapila wrote:
> > > > I don't contribute code. But looking at the dictionary meaning Scribe
> > > fits.
> > > > So my vote is Scribe.
> > > >
> > > > a word that fits and not confused with existing class/
> responsibility?
> > > >
> > > > verb
> > > > 1.
> > > > literary
> > > > write.
> > > > "he scribed a note that he passed to Dan"
> > > >
> > > > On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com>
> > wrote:
> > > >
> > > > > Sorry about that, I'll have a look today or tomorrow.
> > > > >
> > > > > Gary
> > > > >
> > > > > On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com>
> wrote:
> > > > >
> > > > > > Not hearing any other ideas and even though I prefer "Scribe" I
> > will
> > > > > rename
> > > > > > the class to "HelpWriter".
> > > > > >
> > > > > > Thanks everyone for your input.
> > > > > >
> > > > > > On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net>
> > wrote:
> > > > > >
> > > > > > > My vote (which everyone is free to ignore) is still for
> > HelpWriter.
> > > > > It's
> > > > > > > simple and intuitive, and it's consistent with the names of the
> > > methods
> > > > > > the
> > > > > > > interface declares (e.g. writePara, writeTable). I
> > > > > > > find SemanticAppendableDecorator too verbose and I have no
> > > intuition
> > > > > for
> > > > > > > what it means.
> > > > > > >
> > > > > > > Peter
> > > > > > >
> > > > > > > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <claude@xenei.com
> >
> > > wrote:
> > > > > > >
> > > > > > > > If we can settle on a name for the
> > > > > > > > serializer/scribe/writer/printDecorator/amenuensis thing the
> > > rest of
> > > > > > the
> > > > > > > > code is ready. It passes all the tests, it has 100% test
> > > coverage,
> > > > > > and
> > > > > > > it
> > > > > > > > works for what Rat is trying to do.
> > > > > > > >
> > > > > > > >
> > > > > > > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <
> > claude@xenei.com>
> > > > > > wrote:
> > > > > > > >
> > > > > > > > > I have opened
> https://github.com/apache/commons-cli/pull/314
> > > to
> > > > > > track
> > > > > > > > the
> > > > > > > > > proposed changes
> > > > > > > > >
> > > > > > > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
> > > claude@xenei.com>
> > > > > > > wrote:
> > > > > > > > >
> > > > > > > > >> I know some graphics programs use the term "engraver" for
> > code
> > > > > that
> > > > > > > > >> creates the output of graphical representations of things
> > > (like
> > > > > > notes,
> > > > > > > > >> staves, and resets in musical notation). Scribe seems
> like
> > > the
> > > > > > > textual
> > > > > > > > >> equivalent.
> > > > > > > > >>
> > > > > > > > >> If we go with the decorator approach then I think the
> > > underlying
> > > > > > > > >> interface should be SemanticAppendableDecorator.
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >> - Semantic because it describes what to do with the
> > > semantic
> > > > > > terms
> > > > > > > > >> like "paragraph", "header", and "list".
> > > > > > > > >> - Appendable because that is what is wraps.
> > > > > > > > >> - Decorator because that is what it does.
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> > > > > > gilleseran@gmail.com
> > > > > > > >
> > > > > > > > >> wrote:
> > > > > > > > >>
> > > > > > > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> > > > > > garydgregory@gmail.com>
> > > > > > > a
> > > > > > > > >>> écrit :
> > > > > > > > >>> >
> > > > > > > > >>> > It's pretty unusual IMO, not like anything in the JDK
> for
> > > > > > example.
> > > > > > > > >>>
> > > > > > > > >>> Agreed.
> > > > > > > > >>>
> > > > > > > > >>> > I'll see
> > > > > > > > >>> > if I can come up with something tomorrow...
> > > > > > > > >>>
> > > > > > > > >>> How about "PrintDecorator" ?
> > > > > > > > >>>
> > > > > > > > >>> Gilles
> > > > > > > > >>>
> > > > > > > > >>> >>> [...]
> > > > > > > > >>>
> > > > > > > > >>>
> > > > > >
> > ---------------------------------------------------------------------
> > > > > > > > >>> To unsubscribe, e-mail:
> dev-unsubscribe@commons.apache.org
> > > > > > > > >>> For additional commands, e-mail:
> > dev-help@commons.apache.org
> > > > > > > > >>>
> > > > > > > > >>>
> > > > > > > > >>
> > > > > > > > >> --
> > > > > > > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > > > >>
> > > > > > > > >
> > > > > > > > >
> > > > > > > > > --
> > > > > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > > > >
> > > > > > > >
> > > > > > > >
> > > > > > > > --
> > > > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > > >
> > > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > >
> > > > >
> > > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > For additional commands, e-mail: dev-help@commons.apache.org
> > >
> > >
> >
>
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Eric Pugh <ep...@opensourceconnections.com>.
I am starting to poke at the CLI-339 feature.. Looking at the PR,
https://github.com/apache/commons-cli/pull/314/files#diff-c5837d81e3e4f87d5222b1d8caa45c9c9cd2c6edff6ad31e3a0b603f0b64d389,
I see the code... I am not quite seeing the big picture however... I
am hoping to see some docs on "How to use the new Help Formatter
extensions"...
It does seem like JavaDocs are our primary documentation format over the
website usage.html page...
I'm hoping to confirm that what Claude wrote (thank you!!) works the way we
want it to before 1.10 goes out!
On Fri, Oct 4, 2024 at 12:56 PM Claude Warren <cl...@xenei.com> wrote:
> Thx Gary. I will review this weekend.
>
> On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
>
> > Hi all,
> >
> > I wrote a bunch of comments in the PR.
> >
> > Gary
> >
> > On 2024/10/02 10:57:53 Tushar Kapila wrote:
> > > I don't contribute code. But looking at the dictionary meaning Scribe
> > fits.
> > > So my vote is Scribe.
> > >
> > > a word that fits and not confused with existing class/ responsibility?
> > >
> > > verb
> > > 1.
> > > literary
> > > write.
> > > "he scribed a note that he passed to Dan"
> > >
> > > On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com>
> wrote:
> > >
> > > > Sorry about that, I'll have a look today or tomorrow.
> > > >
> > > > Gary
> > > >
> > > > On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com> wrote:
> > > >
> > > > > Not hearing any other ideas and even though I prefer "Scribe" I
> will
> > > > rename
> > > > > the class to "HelpWriter".
> > > > >
> > > > > Thanks everyone for your input.
> > > > >
> > > > > On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net>
> wrote:
> > > > >
> > > > > > My vote (which everyone is free to ignore) is still for
> HelpWriter.
> > > > It's
> > > > > > simple and intuitive, and it's consistent with the names of the
> > methods
> > > > > the
> > > > > > interface declares (e.g. writePara, writeTable). I
> > > > > > find SemanticAppendableDecorator too verbose and I have no
> > intuition
> > > > for
> > > > > > what it means.
> > > > > >
> > > > > > Peter
> > > > > >
> > > > > > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com>
> > wrote:
> > > > > >
> > > > > > > If we can settle on a name for the
> > > > > > > serializer/scribe/writer/printDecorator/amenuensis thing the
> > rest of
> > > > > the
> > > > > > > code is ready. It passes all the tests, it has 100% test
> > coverage,
> > > > > and
> > > > > > it
> > > > > > > works for what Rat is trying to do.
> > > > > > >
> > > > > > >
> > > > > > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <
> claude@xenei.com>
> > > > > wrote:
> > > > > > >
> > > > > > > > I have opened https://github.com/apache/commons-cli/pull/314
> > to
> > > > > track
> > > > > > > the
> > > > > > > > proposed changes
> > > > > > > >
> > > > > > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
> > claude@xenei.com>
> > > > > > wrote:
> > > > > > > >
> > > > > > > >> I know some graphics programs use the term "engraver" for
> code
> > > > that
> > > > > > > >> creates the output of graphical representations of things
> > (like
> > > > > notes,
> > > > > > > >> staves, and resets in musical notation). Scribe seems like
> > the
> > > > > > textual
> > > > > > > >> equivalent.
> > > > > > > >>
> > > > > > > >> If we go with the decorator approach then I think the
> > underlying
> > > > > > > >> interface should be SemanticAppendableDecorator.
> > > > > > > >>
> > > > > > > >>
> > > > > > > >> - Semantic because it describes what to do with the
> > semantic
> > > > > terms
> > > > > > > >> like "paragraph", "header", and "list".
> > > > > > > >> - Appendable because that is what is wraps.
> > > > > > > >> - Decorator because that is what it does.
> > > > > > > >>
> > > > > > > >>
> > > > > > > >>
> > > > > > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> > > > > gilleseran@gmail.com
> > > > > > >
> > > > > > > >> wrote:
> > > > > > > >>
> > > > > > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> > > > > garydgregory@gmail.com>
> > > > > > a
> > > > > > > >>> écrit :
> > > > > > > >>> >
> > > > > > > >>> > It's pretty unusual IMO, not like anything in the JDK for
> > > > > example.
> > > > > > > >>>
> > > > > > > >>> Agreed.
> > > > > > > >>>
> > > > > > > >>> > I'll see
> > > > > > > >>> > if I can come up with something tomorrow...
> > > > > > > >>>
> > > > > > > >>> How about "PrintDecorator" ?
> > > > > > > >>>
> > > > > > > >>> Gilles
> > > > > > > >>>
> > > > > > > >>> >>> [...]
> > > > > > > >>>
> > > > > > > >>>
> > > > >
> ---------------------------------------------------------------------
> > > > > > > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > > > > > >>> For additional commands, e-mail:
> dev-help@commons.apache.org
> > > > > > > >>>
> > > > > > > >>>
> > > > > > > >>
> > > > > > > >> --
> > > > > > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > > >>
> > > > > > > >
> > > > > > > >
> > > > > > > > --
> > > > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > > >
> > > > > > >
> > > > > > >
> > > > > > > --
> > > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > >
> > > > > >
> > > > >
> > > > >
> > > > > --
> > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > >
> > > >
> > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
>
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Claude Warren <cl...@xenei.com>.
Thx Gary. I will review this weekend.
On Fri 4 Oct 2024, 15:41 Gary D. Gregory, <gg...@apache.org> wrote:
> Hi all,
>
> I wrote a bunch of comments in the PR.
>
> Gary
>
> On 2024/10/02 10:57:53 Tushar Kapila wrote:
> > I don't contribute code. But looking at the dictionary meaning Scribe
> fits.
> > So my vote is Scribe.
> >
> > a word that fits and not confused with existing class/ responsibility?
> >
> > verb
> > 1.
> > literary
> > write.
> > "he scribed a note that he passed to Dan"
> >
> > On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com> wrote:
> >
> > > Sorry about that, I'll have a look today or tomorrow.
> > >
> > > Gary
> > >
> > > On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com> wrote:
> > >
> > > > Not hearing any other ideas and even though I prefer "Scribe" I will
> > > rename
> > > > the class to "HelpWriter".
> > > >
> > > > Thanks everyone for your input.
> > > >
> > > > On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net> wrote:
> > > >
> > > > > My vote (which everyone is free to ignore) is still for HelpWriter.
> > > It's
> > > > > simple and intuitive, and it's consistent with the names of the
> methods
> > > > the
> > > > > interface declares (e.g. writePara, writeTable). I
> > > > > find SemanticAppendableDecorator too verbose and I have no
> intuition
> > > for
> > > > > what it means.
> > > > >
> > > > > Peter
> > > > >
> > > > > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com>
> wrote:
> > > > >
> > > > > > If we can settle on a name for the
> > > > > > serializer/scribe/writer/printDecorator/amenuensis thing the
> rest of
> > > > the
> > > > > > code is ready. It passes all the tests, it has 100% test
> coverage,
> > > > and
> > > > > it
> > > > > > works for what Rat is trying to do.
> > > > > >
> > > > > >
> > > > > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <cl...@xenei.com>
> > > > wrote:
> > > > > >
> > > > > > > I have opened https://github.com/apache/commons-cli/pull/314
> to
> > > > track
> > > > > > the
> > > > > > > proposed changes
> > > > > > >
> > > > > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <
> claude@xenei.com>
> > > > > wrote:
> > > > > > >
> > > > > > >> I know some graphics programs use the term "engraver" for code
> > > that
> > > > > > >> creates the output of graphical representations of things
> (like
> > > > notes,
> > > > > > >> staves, and resets in musical notation). Scribe seems like
> the
> > > > > textual
> > > > > > >> equivalent.
> > > > > > >>
> > > > > > >> If we go with the decorator approach then I think the
> underlying
> > > > > > >> interface should be SemanticAppendableDecorator.
> > > > > > >>
> > > > > > >>
> > > > > > >> - Semantic because it describes what to do with the
> semantic
> > > > terms
> > > > > > >> like "paragraph", "header", and "list".
> > > > > > >> - Appendable because that is what is wraps.
> > > > > > >> - Decorator because that is what it does.
> > > > > > >>
> > > > > > >>
> > > > > > >>
> > > > > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> > > > gilleseran@gmail.com
> > > > > >
> > > > > > >> wrote:
> > > > > > >>
> > > > > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> > > > garydgregory@gmail.com>
> > > > > a
> > > > > > >>> écrit :
> > > > > > >>> >
> > > > > > >>> > It's pretty unusual IMO, not like anything in the JDK for
> > > > example.
> > > > > > >>>
> > > > > > >>> Agreed.
> > > > > > >>>
> > > > > > >>> > I'll see
> > > > > > >>> > if I can come up with something tomorrow...
> > > > > > >>>
> > > > > > >>> How about "PrintDecorator" ?
> > > > > > >>>
> > > > > > >>> Gilles
> > > > > > >>>
> > > > > > >>> >>> [...]
> > > > > > >>>
> > > > > > >>>
> > > > ---------------------------------------------------------------------
> > > > > > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > > > > >>> For additional commands, e-mail: dev-help@commons.apache.org
> > > > > > >>>
> > > > > > >>>
> > > > > > >>
> > > > > > >> --
> > > > > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > >>
> > > > > > >
> > > > > > >
> > > > > > > --
> > > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > >
> > > > >
> > > >
> > > >
> > > > --
> > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > >
> > >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by "Gary D. Gregory" <gg...@apache.org>.
Hi all,
I wrote a bunch of comments in the PR.
Gary
On 2024/10/02 10:57:53 Tushar Kapila wrote:
> I don't contribute code. But looking at the dictionary meaning Scribe fits.
> So my vote is Scribe.
>
> a word that fits and not confused with existing class/ responsibility?
>
> verb
> 1.
> literary
> write.
> "he scribed a note that he passed to Dan"
>
> On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com> wrote:
>
> > Sorry about that, I'll have a look today or tomorrow.
> >
> > Gary
> >
> > On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com> wrote:
> >
> > > Not hearing any other ideas and even though I prefer "Scribe" I will
> > rename
> > > the class to "HelpWriter".
> > >
> > > Thanks everyone for your input.
> > >
> > > On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net> wrote:
> > >
> > > > My vote (which everyone is free to ignore) is still for HelpWriter.
> > It's
> > > > simple and intuitive, and it's consistent with the names of the methods
> > > the
> > > > interface declares (e.g. writePara, writeTable). I
> > > > find SemanticAppendableDecorator too verbose and I have no intuition
> > for
> > > > what it means.
> > > >
> > > > Peter
> > > >
> > > > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com> wrote:
> > > >
> > > > > If we can settle on a name for the
> > > > > serializer/scribe/writer/printDecorator/amenuensis thing the rest of
> > > the
> > > > > code is ready. It passes all the tests, it has 100% test coverage,
> > > and
> > > > it
> > > > > works for what Rat is trying to do.
> > > > >
> > > > >
> > > > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <cl...@xenei.com>
> > > wrote:
> > > > >
> > > > > > I have opened https://github.com/apache/commons-cli/pull/314 to
> > > track
> > > > > the
> > > > > > proposed changes
> > > > > >
> > > > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <cl...@xenei.com>
> > > > wrote:
> > > > > >
> > > > > >> I know some graphics programs use the term "engraver" for code
> > that
> > > > > >> creates the output of graphical representations of things (like
> > > notes,
> > > > > >> staves, and resets in musical notation). Scribe seems like the
> > > > textual
> > > > > >> equivalent.
> > > > > >>
> > > > > >> If we go with the decorator approach then I think the underlying
> > > > > >> interface should be SemanticAppendableDecorator.
> > > > > >>
> > > > > >>
> > > > > >> - Semantic because it describes what to do with the semantic
> > > terms
> > > > > >> like "paragraph", "header", and "list".
> > > > > >> - Appendable because that is what is wraps.
> > > > > >> - Decorator because that is what it does.
> > > > > >>
> > > > > >>
> > > > > >>
> > > > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> > > gilleseran@gmail.com
> > > > >
> > > > > >> wrote:
> > > > > >>
> > > > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> > > garydgregory@gmail.com>
> > > > a
> > > > > >>> écrit :
> > > > > >>> >
> > > > > >>> > It's pretty unusual IMO, not like anything in the JDK for
> > > example.
> > > > > >>>
> > > > > >>> Agreed.
> > > > > >>>
> > > > > >>> > I'll see
> > > > > >>> > if I can come up with something tomorrow...
> > > > > >>>
> > > > > >>> How about "PrintDecorator" ?
> > > > > >>>
> > > > > >>> Gilles
> > > > > >>>
> > > > > >>> >>> [...]
> > > > > >>>
> > > > > >>>
> > > ---------------------------------------------------------------------
> > > > > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > > > >>> For additional commands, e-mail: dev-help@commons.apache.org
> > > > > >>>
> > > > > >>>
> > > > > >>
> > > > > >> --
> > > > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > >>
> > > > > >
> > > > > >
> > > > > > --
> > > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > > >
> > > > >
> > > > >
> > > > > --
> > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > >
> > > >
> > >
> > >
> > > --
> > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > >
> >
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Tushar Kapila <tg...@gmail.com>.
I don't contribute code. But looking at the dictionary meaning Scribe fits.
So my vote is Scribe.
a word that fits and not confused with existing class/ responsibility?
verb
1.
literary
write.
"he scribed a note that he passed to Dan"
On Wed, 2 Oct 2024, 14:35 Gary Gregory, <ga...@gmail.com> wrote:
> Sorry about that, I'll have a look today or tomorrow.
>
> Gary
>
> On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com> wrote:
>
> > Not hearing any other ideas and even though I prefer "Scribe" I will
> rename
> > the class to "HelpWriter".
> >
> > Thanks everyone for your input.
> >
> > On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net> wrote:
> >
> > > My vote (which everyone is free to ignore) is still for HelpWriter.
> It's
> > > simple and intuitive, and it's consistent with the names of the methods
> > the
> > > interface declares (e.g. writePara, writeTable). I
> > > find SemanticAppendableDecorator too verbose and I have no intuition
> for
> > > what it means.
> > >
> > > Peter
> > >
> > > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com> wrote:
> > >
> > > > If we can settle on a name for the
> > > > serializer/scribe/writer/printDecorator/amenuensis thing the rest of
> > the
> > > > code is ready. It passes all the tests, it has 100% test coverage,
> > and
> > > it
> > > > works for what Rat is trying to do.
> > > >
> > > >
> > > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <cl...@xenei.com>
> > wrote:
> > > >
> > > > > I have opened https://github.com/apache/commons-cli/pull/314 to
> > track
> > > > the
> > > > > proposed changes
> > > > >
> > > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <cl...@xenei.com>
> > > wrote:
> > > > >
> > > > >> I know some graphics programs use the term "engraver" for code
> that
> > > > >> creates the output of graphical representations of things (like
> > notes,
> > > > >> staves, and resets in musical notation). Scribe seems like the
> > > textual
> > > > >> equivalent.
> > > > >>
> > > > >> If we go with the decorator approach then I think the underlying
> > > > >> interface should be SemanticAppendableDecorator.
> > > > >>
> > > > >>
> > > > >> - Semantic because it describes what to do with the semantic
> > terms
> > > > >> like "paragraph", "header", and "list".
> > > > >> - Appendable because that is what is wraps.
> > > > >> - Decorator because that is what it does.
> > > > >>
> > > > >>
> > > > >>
> > > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> > gilleseran@gmail.com
> > > >
> > > > >> wrote:
> > > > >>
> > > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> > garydgregory@gmail.com>
> > > a
> > > > >>> écrit :
> > > > >>> >
> > > > >>> > It's pretty unusual IMO, not like anything in the JDK for
> > example.
> > > > >>>
> > > > >>> Agreed.
> > > > >>>
> > > > >>> > I'll see
> > > > >>> > if I can come up with something tomorrow...
> > > > >>>
> > > > >>> How about "PrintDecorator" ?
> > > > >>>
> > > > >>> Gilles
> > > > >>>
> > > > >>> >>> [...]
> > > > >>>
> > > > >>>
> > ---------------------------------------------------------------------
> > > > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > > >>> For additional commands, e-mail: dev-help@commons.apache.org
> > > > >>>
> > > > >>>
> > > > >>
> > > > >> --
> > > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > >>
> > > > >
> > > > >
> > > > > --
> > > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > > >
> > > >
> > > >
> > > > --
> > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > >
> > >
> >
> >
> > --
> > LinkedIn: http://www.linkedin.com/in/claudewarren
> >
>
Re: [CLI] [DISCUSS] Help formatter extension proposal
Posted by Gary Gregory <ga...@gmail.com>.
Sorry about that, I'll have a look today or tomorrow.
Gary
On Wed, Oct 2, 2024, 3:39 AM Claude Warren <cl...@xenei.com> wrote:
> Not hearing any other ideas and even though I prefer "Scribe" I will rename
> the class to "HelpWriter".
>
> Thanks everyone for your input.
>
> On Mon, Sep 30, 2024 at 9:26 PM Peter Burka <pe...@quux.net> wrote:
>
> > My vote (which everyone is free to ignore) is still for HelpWriter. It's
> > simple and intuitive, and it's consistent with the names of the methods
> the
> > interface declares (e.g. writePara, writeTable). I
> > find SemanticAppendableDecorator too verbose and I have no intuition for
> > what it means.
> >
> > Peter
> >
> > On Mon, Sep 30, 2024, 12:31 PM Claude Warren <cl...@xenei.com> wrote:
> >
> > > If we can settle on a name for the
> > > serializer/scribe/writer/printDecorator/amenuensis thing the rest of
> the
> > > code is ready. It passes all the tests, it has 100% test coverage,
> and
> > it
> > > works for what Rat is trying to do.
> > >
> > >
> > > On Sat, Sep 28, 2024 at 2:08 PM Claude Warren <cl...@xenei.com>
> wrote:
> > >
> > > > I have opened https://github.com/apache/commons-cli/pull/314 to
> track
> > > the
> > > > proposed changes
> > > >
> > > > On Sat, Sep 28, 2024 at 11:42 AM Claude Warren <cl...@xenei.com>
> > wrote:
> > > >
> > > >> I know some graphics programs use the term "engraver" for code that
> > > >> creates the output of graphical representations of things (like
> notes,
> > > >> staves, and resets in musical notation). Scribe seems like the
> > textual
> > > >> equivalent.
> > > >>
> > > >> If we go with the decorator approach then I think the underlying
> > > >> interface should be SemanticAppendableDecorator.
> > > >>
> > > >>
> > > >> - Semantic because it describes what to do with the semantic
> terms
> > > >> like "paragraph", "header", and "list".
> > > >> - Appendable because that is what is wraps.
> > > >> - Decorator because that is what it does.
> > > >>
> > > >>
> > > >>
> > > >> On Sat, Sep 28, 2024 at 9:26 AM Gilles Sadowski <
> gilleseran@gmail.com
> > >
> > > >> wrote:
> > > >>
> > > >>> Le sam. 28 sept. 2024 à 00:17, Gary Gregory <
> garydgregory@gmail.com>
> > a
> > > >>> écrit :
> > > >>> >
> > > >>> > It's pretty unusual IMO, not like anything in the JDK for
> example.
> > > >>>
> > > >>> Agreed.
> > > >>>
> > > >>> > I'll see
> > > >>> > if I can come up with something tomorrow...
> > > >>>
> > > >>> How about "PrintDecorator" ?
> > > >>>
> > > >>> Gilles
> > > >>>
> > > >>> >>> [...]
> > > >>>
> > > >>>
> ---------------------------------------------------------------------
> > > >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > >>> For additional commands, e-mail: dev-help@commons.apache.org
> > > >>>
> > > >>>
> > > >>
> > > >> --
> > > >> LinkedIn: http://www.linkedin.com/in/claudewarren
> > > >>
> > > >
> > > >
> > > > --
> > > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > > >
> > >
> > >
> > > --
> > > LinkedIn: http://www.linkedin.com/in/claudewarren
> > >
> >
>
>
> --
> LinkedIn: http://www.linkedin.com/in/claudewarren
>