Re: [netmod] rfc 6087bis - stress importance of instance examples

Martin Bjorklund <mbj@tail-f.com> Wed, 08 March 2017 01:07 UTC

Return-Path: <mbj@tail-f.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id C254F129470 for <netmod@ietfa.amsl.com>; Tue, 7 Mar 2017 17:07:50 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.359
X-Spam-Level:
X-Spam-Status: No, score=-0.359 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DATE_IN_PAST_06_12=1.543, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001] autolearn=no autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id PUR60yGzCMTG for <netmod@ietfa.amsl.com>; Tue, 7 Mar 2017 17:07:49 -0800 (PST)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id B59A71294AE for <netmod@ietf.org>; Tue, 7 Mar 2017 17:07:49 -0800 (PST)
Received: from localhost (unknown [50.225.114.198]) by mail.tail-f.com (Postfix) with ESMTPSA id 968671AE0493; Wed, 8 Mar 2017 01:58:27 +0100 (CET)
Date: Tue, 07 Mar 2017 18:59:11 +0100 (CET)
Message-Id: <20170307.185911.779366639761395028.mbj@tail-f.com>
To: j.schoenwaelder@jacobs-university.de
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <20170303191348.GA3570@elstar.local>
References: <20170303191348.GA3570@elstar.local>
X-Mailer: Mew version 6.5 on Emacs 24.3 / Mule 6.0 (HANACHIRUSATO)
Mime-Version: 1.0
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/QHc7u8x-SegrexsaM7pY93Rnz0M>
Cc: netmod@ietf.org
Subject: Re: [netmod] rfc 6087bis - stress importance of instance examples
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 08 Mar 2017 01:07:51 -0000

Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> wrote:
> Hi,
> 
> my experience is that when writing YANG modules it is tremendously
> helpful to focus on the instance documents. I find it essential to
> write down example snippets of instance documents to see whether they
> look elegant or clumsy. This is often not easy to determine from just
> reading a YANG model, in particular if groupings are involved. Examples
> help so much - you can easily spot whether the usage of singular or
> plural is reasonable in your names, whether you have redundancy in
> your names, whether the overall organization is effective. Even better,
> we have tools that can validate the examples so we can even be sure
> the examples are correct. (And if you do not know whether you got
> your pattern statement right, well, one way is to write examples.)
> 
> 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.


/martin

> It will help
> them to create better models and it will help reviewers tremendously
> while reviewing models. Good examples will also help users to get
> started.
> 
> /js (who apparently is doing some heavy YANG reviewing work today)
> 
> -- 
> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
> Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   +49 421 200 3103         <http://www.jacobs-university.de/>
> 
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
>