Re: [netmod] New Version Notification for draft-kwatsen-netmod-artwork-folding-07.txt

Hi,

Kent Watsen <kwatsen@juniper.net> wrote:
> Hi Tom,
> 
> 
> >> Good enough?
> >
> > No:-)  The authors of YANG modules seem not to understand that it
> > applies to them, or incorrectly use the tools that would apply 
> > were they correctly used.  
> 
> This seems to be a problem outside the scope of this draft.  I was 
> thinking to strengthen Section 4.2 some, but this sentence really
> seems to say it right:
> 
>    As such, it is RECOMMENDED that authors do as much as possible
>    within the selected format to avoid long lines.

I think you also should change the first paragraph in section 3.1:

   Automated folding of long lines is needed in order to support draft
   compilations that entail a) validation of source input files (e.g.,
   YANG, XML, JSON, ABNF, ASN.1) and/or b) dynamic generation of output
   (e.g., tree diagrams) that are stitched into the final document to be
   submitted.

At least remove YANG from the example, and I also think that
auto-folding of tree diagrams should be strongly discouraged, so find
a better example for (b).

Also remove YANG from 4.1

To further emphasize this, I think you should add YANG and tree
diagrams as examples in section 4.2.

/martin

> 
> 
> > OLD
> > [RFC7994][RFC7994]sets out the requirements for plain-text RFCs and
> >   states that each line of an RFC (and hence of an Internet-Draft) must
> >   be limited to 72 characters followed by the character sequence that
> >   denotes an end-of-line (EOL).
> >
> > NEW
> > [RFC7994]sets out the requirements for plain-text RFCs and
> >   states that each line of an RFC (and hence of an Internet-Draft) must
> >   be limited to 72 characters followed by the character sequence that
> >   denotes an end-of-line (EOL).  This applies to all of an RFC,
> >   including, for example, the comments or description clauses in a YANG
> >   module, and to artwork.
> 
> First, I'd recommend simplifying the last sentence to just "This applies
> to all of an RFC, including any artwork.", but then it seems to step on
> what the next paragraph says.  Perhaps the next paragraph could be 
> simplified? - suggestions welcomed.
> 
> 
> > Not sure why you have [RFC7994] twice.
> 
> Fixed in my local copy.
> 
> 
> PS: folded YANG-modules will break tooling (e.g., module validation) until
> extraction tools (i.e., `xym`) are updated to be folding aware.  Even after
> this draft becomes an RFC, authors need to ensure that YANG modules are not
> folded until such tools are updated.  Other artwork (tree diagrams, instance
> examples, etc.) being folded is not a problem, as no automated tooling acts
> on them currently.
> 
> 
> Kent // contributor
> 
> 
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
> 
> 