There are a growing number of I-D which augment ietf-te-topology which means 80 
or more augment, covering 20 or so pages of tree diagram, 40 or so pages of 
YANG.  That makes for a tough read.

I think that these need breaking up as  a recent review of flexigrid-yang 
suggested.

The more considerate authors add comments to the YANG (something a YANG Doctor 
can suggest) but I think that the comments are needed in the tree diagram so 
that the two can be tied together.  This was suggested by the reviewer of 
flexigrid-yang.  In fact, I made such a comment against  ccamp-otn-topology to 
which the author replied that the tree diagram was tool-generated,  (This is 
good as some authors hand craft tree diagrams and the YANG and Tree Diagram are 
then out-of-line).

How about the generation of the tree diagram looking for comment lines in the 
YANG - /* 
 */  - before an augment and generating the same text as a comment in the tree 
diagram?

Some authors put comments everywhere but I understand that the guidance from 
YANG Doctors is to make that part of the YANG description clause so that 
practice should cease,

Tom Petch
_______________________________________________
netmod mailing list
[email protected]
https://www.ietf.org/mailman/listinfo/netmod

Reply via email to