Re: [netmod] summary line in descriptions

Martin Bjorklund <mbj@tail-f.com> Wed, 06 December 2017 14:02 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 1B29E12896F for <netmod@ietfa.amsl.com>; Wed, 6 Dec 2017 06:02:08 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.901
X-Spam-Level:
X-Spam-Status: No, score=-1.901 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_PASS=-0.001] autolearn=ham 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 g2osaoWs1qDx for <netmod@ietfa.amsl.com>; Wed, 6 Dec 2017 06:02:01 -0800 (PST)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id AACB91200B9 for <netmod@ietf.org>; Wed, 6 Dec 2017 06:02:01 -0800 (PST)
Received: from localhost (unknown [173.38.220.60]) by mail.tail-f.com (Postfix) with ESMTPSA id B52201AE0141; Wed, 6 Dec 2017 15:02:00 +0100 (CET)
Date: Wed, 06 Dec 2017 15:00:41 +0100
Message-Id: <20171206.150041.1063143145053874766.mbj@tail-f.com>
To: lhotka@nic.cz
Cc: j.schoenwaelder@jacobs-university.de, netmod@ietf.org
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <1512568549.2653.62.camel@nic.cz>
References: <20171206131405.cwi4eoikau67abps@elstar.local> <20171206.145110.2020944959715437189.mbj@tail-f.com> <1512568549.2653.62.camel@nic.cz>
X-Mailer: Mew version 6.7 on Emacs 24.5 / 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/RWLd0vbA1-3u1RTlR5yS-f_i_Cg>
Subject: Re: [netmod] summary line in descriptions
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
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, 06 Dec 2017 14:02:08 -0000

Ladislav Lhotka <lhotka@nic.cz> wrote:
> On Wed, 2017-12-06 at 14:51 +0100, Martin Bjorklund wrote:
> > Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> wrote:
> > > I am not sure design decisions of some web clients that provide clumsy
> > > user experience should impact how we write data models. If we need
> > > summary lines, we should properly separate them via
> > > 
> > >   ext:summary "this does magic, see the description"
> > > 
> > > instead of relying on conventions.
> > 
> > I agree.  Incidentally, that's what we do (with a vendor specific
> > extension).
> 
> So if you have a single-line description, you replicate it in this extension's
> parameter?

I have seen that.  In some cases people simply don't put in the normal
description in that case, just tailf:info.  But for "real" nodes, the
description tend to be longer than the short info.


/martin



> 
> Lada
> 
> > 
> > 
> > /martin
> > 
> > 
> > > 
> > > /js
> > > 
> > > On Wed, Dec 06, 2017 at 01:37:36PM +0100, Ladislav Lhotka wrote:
> > > > Hi,
> > > > 
> > > > although detailed descriptions is a good thing, my recent experiences with
> > web
> > > > clients for RESTCONF indicate that they can become clumsy and unwieldy in
> > such
> > > > user interfaces. I think it would be useful to adopt a convention similar
> > to Git
> > > > commit messages: one relatively short summary line followed by an empty
> > line,
> > > > and the rest of the description after that. User interfaces could then
> > easily
> > > > recognize and use the summary line.
> > > > 
> > > > Perhaps 6087bis could include such a recommendation.
> > > > 
> > > > Lada
> > > > 
> > > > -- 
> > > > Ladislav Lhotka
> > > > Head, CZ.NIC Labs
> > > > PGP Key ID: 0xB8F92B08A9F76C67
> > > > 
> > > > _______________________________________________
> > > > netmod mailing list
> > > > netmod@ietf.org
> > > > https://www.ietf.org/mailman/listinfo/netmod
> > > 
> > > -- 
> > > 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
> > > 
> -- 
> Ladislav Lhotka
> Head, CZ.NIC Labs
> PGP Key ID: 0xB8F92B08A9F76C67
>