> On 8 Mar 2017, at 18:40, Kent Watsen <[email protected]> wrote: > > > >>> I think we should encourage authors to write examples. >> >> +1 And also encourage authors to validate the examples >> using their favorite YANG instance validation tool. > > > Please note this from the latest 6087bis update: > > 4.12. Module Usage Examples > > Each specification that defines one or more modules SHOULD contain > usage examples, either throughout the document or in an appendix. > This includes example XML instance document snippets to demonstrate > the intended usage of the YANG module(s). > > and I already wrote this: > > Nice addition, but should it say something about JSON, in addition to XML?
I'd suggest: "This includes example instance documents or snippets in an appropriate encoding to demonstrate the intended usage of the YANG module(s)." Lada > Perhaps that, unless there is a reason to only pick one encoding, examples > should be split between the two? - just throwing it out there to see if > this is > something we might want to recommend...thoughts? > > https://mailarchive.ietf.org/arch/msg/netmod/dOpSYzM_J05Sdmgt-MyYmqJIUz0 > > > K. > > > _______________________________________________ > netmod mailing list > [email protected] > https://www.ietf.org/mailman/listinfo/netmod -- Ladislav Lhotka, CZ.NIC Labs PGP Key ID: 0xB8F92B08A9F76C67 _______________________________________________ netmod mailing list [email protected] https://www.ietf.org/mailman/listinfo/netmod
