IETF Logo Mail Archive

Re: [Rats] [rfc-i] document conventions around Capitalization of Terminology

Brian E Carpenter <brian.e.carpenter@gmail.com> Tue, 13 April 2021 22:19 UTC

Return-Path: <brian.e.carpenter@gmail.com>
X-Original-To: rats@ietfa.amsl.com
Delivered-To: rats@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 0F3D13A12B4 for <rats@ietfa.amsl.com>; Tue, 13 Apr 2021 15:19:48 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.099
X-Spam-Level:
X-Spam-Status: No, score=-2.099 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 kirZrlkX7SfV for <rats@ietfa.amsl.com>; Tue, 13 Apr 2021 15:19:46 -0700 (PDT)
Received: from mail-pf1-x430.google.com (mail-pf1-x430.google.com [IPv6:2607:f8b0:4864:20::430]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 0C5703A12AF for <rats@ietf.org>; Tue, 13 Apr 2021 15:19:45 -0700 (PDT)
Received: by mail-pf1-x430.google.com with SMTP id o123so12376356pfb.4 for <rats@ietf.org>; Tue, 13 Apr 2021 15:19:45 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=EYyGjmtBKny3ypyuK+JwScSsSjTbekIo8iQHhqsXCrg=; b=IcQR19QW9r1etK5BWCyoD+k8bBB3ZPO+VzBHw7XaOUB42wwOJrKXZP3jK8AM6LelaM 5iRaCRzqXqce5ojI1ZWfIulOQalfCq6uWyQNQkGMt4HYMN0QzeJin6d2f8QUm2vzIuLc iibB8O0eyEBcpZk8H5oPBWfp9TzBWojH/RkHFDsSQw8Ydf+EtoDIbpQNX40zj2kW8r/V RTuYvvZSkepJpiMaCKyasykBXUbDWOT1hTeoRuA5ueL0X0jFl1iN5gKoEkTA5zeG6KPy mQ8pnO5JPWBIwhRb2WqXKxtp26ktrpdGN/foLSUInioVtfWszC5PEzKop8/d+ehQFdyk jKiQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=EYyGjmtBKny3ypyuK+JwScSsSjTbekIo8iQHhqsXCrg=; b=Aa6tyCPi6SXLjBXw2NfjDTkreKbkWBqzOUdovXpstPLpoOMKniuD0BmoibQ3FKr9QH XR3+uJudSzq0jjGF0fQloG0qZByC+e4xUiscUD/87RK2d/gooujLkRRZfR1ElP9AUkKv B4+Q5AIbh3vXkiB8OtHyB4XGrIojnOIz0PWhuz2RUb7Shl9kUWFKvtI8ddj2lb/1TlZq C6NsvfbE8I99qhxfK4kCjn4RXIKEv2njobtTPswFKOenCLAtJYuwl7i6VMG1yql3WqaF 7fpM4LbYpeCqrYiNs1ym+2HELtP17k0swwkmlZ+Q80pvotlx9igYw4Qafdw2ZfZ0dchF 89Kg==
X-Gm-Message-State: AOAM531+xzl72FhKED5RYmaOqE0seW8xyK0xSmN8fDqwk2qKQ73j86Ba Zgl2sodhF2NZBkd5BVjC68A=
X-Google-Smtp-Source: ABdhPJzYtd3xdqOEjxCHzdCAHoej95oWbBR5FNPyOckfmsRVL8tTYVk6Xa3aQeZsfpD3oc4hpzz8Kg==
X-Received: by 2002:a63:175c:: with SMTP id 28mr33231788pgx.376.1618352383899; Tue, 13 Apr 2021 15:19:43 -0700 (PDT)
Received: from [192.168.178.20] ([151.210.131.14]) by smtp.gmail.com with ESMTPSA id jz8sm3181655pjb.11.2021.04.13.15.19.41 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 13 Apr 2021 15:19:43 -0700 (PDT)
To: Dave Thaler <dthaler@microsoft.com>, Paul Hoffman <paul.hoffman@vpnc.org>, Michael Richardson <mcr+ietf@sandelman.ca>
Cc: "rats@ietf.org" <rats@ietf.org>, rfc-interest <rfc-interest@rfc-editor.org>
References: <10996.1618327990@localhost> <92A38E3E-EBD8-4A14-8B47-9080694E736A@vpnc.org> <BYAPR21MB17366C837CB6834BAEDC77F6A34F9@BYAPR21MB1736.namprd21.prod.outlook.com>
From: Brian E Carpenter <brian.e.carpenter@gmail.com>
Message-ID: <15ff2ed0-a804-18ac-5ffe-e75a3d11fb9e@gmail.com>
Date: Wed, 14 Apr 2021 10:19:38 +1200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.9.1
MIME-Version: 1.0
In-Reply-To: <BYAPR21MB17366C837CB6834BAEDC77F6A34F9@BYAPR21MB1736.namprd21.prod.outlook.com>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/rats/ShbwZNBbLUwJM3PS8qJ0Y62R6Z0>
Subject: Re: [Rats] [rfc-i] document conventions around Capitalization of Terminology
X-BeenThere: rats@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Remote ATtestation procedureS <rats.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rats>, <mailto:rats-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rats/>
List-Post: <mailto:rats@ietf.org>
List-Help: <mailto:rats-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rats>, <mailto:rats-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 13 Apr 2021 22:19:48 -0000

On 14-Apr-21 06:16, Dave Thaler wrote:
> Paul Hoffman writes:
>> The convention for techie writers is to assume that new things should be proper nouns. 
>> The convention for copy editors is to make them regular nouns because over-capitalizing makes documents hard to read.
> 
> I completely agree with that.
> 
> As one of the co-editors of the RATS architecture document that Michael mentioned,
> I find it harder to read now that things got capitalized everywhere.

Oh dear. I hate to introduce a potential Red Herring, but an inverse version
of the problem also exists. One of the documents in Cluster 325 (which has
this capitalization problem) happens to contain a couple of sections whose
topic is a lower case parameter name, such as 'asa_handle'. After some
backwards and forwards, the RFC editor has settled on section headings
like '2.3.2.7. asa_handle'. This looks a bit odd, but '2.3.2.7. Asa_handle'
seemed misleading.

   Brian

v2.23.0 | Report a Bug | By Email