From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id MOcDJsnhvmL8eQAAbAwnHQ (envelope-from ) for ; Fri, 01 Jul 2022 14:00:09 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id iBoGJcnhvmI3BwAAG6o9tA (envelope-from ) for ; Fri, 01 Jul 2022 14:00:09 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [135.181.149.255]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 0969C1EEA8 for ; Fri, 1 Jul 2022 14:00:08 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id AA13A5F7EA; Fri, 1 Jul 2022 12:00:06 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id AC7545E53D for ; Fri, 1 Jul 2022 12:00:03 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id 3707E5FBD0; Fri, 1 Jul 2022 08:00:03 -0400 (EDT) Received: (nullmailer pid 119692 invoked by uid 1000); Fri, 01 Jul 2022 12:00:02 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: Re: [PATCH] doc: improve config item labels in info output In-Reply-To: <20220701112801.31971-1-david@tethera.net> References: <20220701112801.31971-1-david@tethera.net> Date: Fri, 01 Jul 2022 09:00:02 -0300 Message-ID: <87pmipf3gd.fsf@tethera.net> MIME-Version: 1.0 Message-ID-Hash: UERGAWNMHHWUTNDP2OFY4O4IJOCTB4FY X-Message-ID-Hash: UERGAWNMHHWUTNDP2OFY4O4IJOCTB4FY X-MailFrom: david@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1656676809; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=iVsxPmXZF3XqFCDFHdjB7uEYDIcWY9l/XNazMU28kXc=; b=eakNAGmByjbkmGsNv2/i7BbXVoaOg5u1JpJvVq0DeJlrNPkpEaO3zZ2py2zT3XnlAkL80F 0Osv1YE2CnEZ8mSEtg7YggyFon2rzoNrsbFxgsM6KsEUrMbWfVd6RvPyT5t7aB7FFrljJC oNGNBzn17htVz/vdWRvDr9scQG+4xv7GCiJX9GEOayqTiJugtEmRlrNhjNYdQAvlq3wJ3G Bgf8x2lFedFYK5Vc0ZS4YI+GMHz4EB/qH3M9KfpY8aoQfoY2ibNRzRHH/Y/84bLNOOvW4g FWQnfjhcc/4hRwHeDx1xUe4asmUaXlZIi/4VL5yz+3YIeWPGZ4FVDiKzMzGVYg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1656676809; a=rsa-sha256; cv=none; b=thfJI5NF4eqHD2qLSqUsisIt4ychjdune7CoRjAiJQvIQtAQLNWzjeqaevAqa/ciCpxNiG FgxZ4CckkPqi+eTt0cUd9gTIYvssOiUo8vTodFGDfuypluSafow8nzmjd4JTQpJcW14wVM FJr5NSV2t8NsdQSV4UyUSoDISdDhkQKUM9iFoIGVmcCoihcrb1Z12yFEW+eI4ZavgTJnxR 6D2G9Ovv8bfpegUEunkmqCwXS0pPsQmz8dz2JejHTNxcexfv9xNuSbW6reADNWO1UAmmPo msPU2n+mL8ttuwwIoE4njl0imXU6xRlDMEcYNGQskaIZHMY/8pQK58QxgHhDpw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -2.76 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 0969C1EEA8 X-Spam-Score: -2.76 X-Migadu-Scanner: scn0.migadu.com X-TUID: y2XUxrMh9Q4Q David Bremner writes: > Commit 306b7028d added the nmconfig role / directive. Unfortunately > the default of using the directive name in texinfo output is pretty > ugly, so attempt to make it more human readable by passing `objname` > to add_object_type invocation. > --- > doc/conf.py | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > - ref_nodeclass=docutils.nodes.generated) > + ref_nodeclass=docutils.nodes.generated, > + objname='config item' ) > -- > 2.35.2 This is the usual "naming is hard" dilemma. It might read nicer as "Notmuch config item", but that is getting long. As far as I can tell this is only relevant for info output.