[netmod] summary line in descriptions

Ladislav Lhotka <lhotka@nic.cz> Wed, 06 December 2017 12:37 UTC

Return-Path: <lhotka@nic.cz>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id EB5DE12762F for <netmod@ietfa.amsl.com>; Wed, 6 Dec 2017 04:37:38 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -7
X-Spam-Status: No, score=-7 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nic.cz
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id mlnQ_vxOY8LQ for <netmod@ietfa.amsl.com>; Wed, 6 Dec 2017 04:37:37 -0800 (PST)
Received: from mail.nic.cz (mail.nic.cz []) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 988D71273E2 for <netmod@ietf.org>; Wed, 6 Dec 2017 04:37:37 -0800 (PST)
Received: from birdie1784 (unknown [IPv6:2001:718:1a02:1::380]) by mail.nic.cz (Postfix) with ESMTPSA id 395176434A for <netmod@ietf.org>; Wed, 6 Dec 2017 13:37:36 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nic.cz; s=default; t=1512563856; bh=DIq7nvtNFHu0CfPlhKEmpktvsAjhWB7+/0fmcmw9B30=; h=From:To:Date; b=jfTkc1OmnQOgIIPvjLkXepJhhq+IcgMsb7EQe6PD7LRSwRzrwY5H4TofQbX3PsKtP LBGwzskOEFPb41VurB6R+bbE+fTyvv8mrBT6wZgZB0VOSeteN0c6pBPhs+nCH9sWv8 dgHuQO9slk8EiLtHePp0ecjCIkFH7iz3yekT0mGE=
Message-ID: <1512563856.2653.41.camel@nic.cz>
From: Ladislav Lhotka <lhotka@nic.cz>
To: NETMOD WG <netmod@ietf.org>
Date: Wed, 06 Dec 2017 13:37:36 +0100
Organization: CZ.NIC
Content-Type: text/plain; charset="UTF-8"
X-Mailer: Evolution 3.26.2
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Virus-Scanned: clamav-milter 0.99.2 at mail
X-Virus-Status: Clean
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/W48xo-irsKBQnfkEATwUPuaCXCQ>
Subject: [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 12:37:39 -0000


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.


Ladislav Lhotka
Head, CZ.NIC Labs
PGP Key ID: 0xB8F92B08A9F76C67