From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id yH7xMBxgQmFQhAEAgWs5BA (envelope-from ) for ; Wed, 15 Sep 2021 23:05:32 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id EO+hLBxgQmGzWgAA1q6Kng (envelope-from ) for ; Wed, 15 Sep 2021 21:05:32 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 354F9B727 for ; Wed, 15 Sep 2021 23:05:32 +0200 (CEST) Received: from localhost ([::1]:40330 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mQc5x-0002AE-QU for larch@yhetil.org; Wed, 15 Sep 2021 17:05:29 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36602) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mQc53-0002A6-Ds for emacs-orgmode@gnu.org; Wed, 15 Sep 2021 17:04:33 -0400 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:45899) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mQc51-00017j-Sb for emacs-orgmode@gnu.org; Wed, 15 Sep 2021 17:04:33 -0400 Received: by mail-wr1-x42e.google.com with SMTP id d21so5918459wra.12 for ; Wed, 15 Sep 2021 14:04:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=00jgPqRo3gaYFpNroB17PcEVGZDyFjQbwFKxnKnWuMw=; b=D+9NnDvhgNgxs1culXxj4vBLvOxyc2x0tvKfYVkdU03ES7XQ7fsXwFJOeOtCoIPyD6 9iLsQt1UXqaD/0axjK0oxA5yIxveL3/LmxNDcz2F504W3BHZMjry9oZLprVYmvgTk2Fj DALmkuAdqvYPVtC4RH5Jfa0j25g5sIhUYVWFu/eVvFvNeLjpYg1FPZBKwrOQkS3euYJF mVaGUY+rI0i7MYsYSEwhpHplLdxWskI6RsWw2t4vCJMdnxMpdmOvEr954RbMdOcZBG38 wuAdUMCiogVUMr8YglsKGNO5qiTcJNhrqtbFQfOFZJBoYRzdeWELF1WQIVz3w1bv+SZB HANw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=00jgPqRo3gaYFpNroB17PcEVGZDyFjQbwFKxnKnWuMw=; b=mY6f2eNgXsNyyajONPF8Z2i5KXjAvHkS/Y83GQOdONlUVDe8/BHNbiqoqC7Dobncwm tQlR8+kRtLQPdGfsb/BlXWcAMnbZ0UwXeym0IKv/MP0Z6GUrw+3AMSgst/mMSqnYYtDn Y1Wu1qbe4SLTsglXxY0UyKZtcNnRA3mykTbRxaCawGdkutRvGA28tCSDoTY+S8Yl6+XQ JWBRm2hYQVdzQEtmbcGu0ocQi0URpsEseiYhC0J7mKdwDTh/pEK7ujcFWapbPlMb68Ew Ox+zVeLdkZ9vpez3EdcHCCZ8b3r7t3G5SVBfUJ8tzzlBbUWuOXqi9QhAfyyM7mnxnPpd jo8g== X-Gm-Message-State: AOAM531+rbpUsQ6xgj+rJ5kmCZKQinu5eEYQNgsVSRpMiZDkBkxCq2tY k2TmCTlPk/dEyUltjKkznXY= X-Google-Smtp-Source: ABdhPJwz3K7LvG3CEJTfq51V506aQq8+BMVs/e6v4xTggZZgGqihsp5axCGYQN33pU9XBJ5fuCjExQ== X-Received: by 2002:adf:f24a:: with SMTP id b10mr2215782wrp.281.1631739868665; Wed, 15 Sep 2021 14:04:28 -0700 (PDT) Received: from aspire-5942 (p200300d8674a2700e0f6e5902d9584c8.dip0.t-ipconnect.de. [2003:d8:674a:2700:e0f6:e590:2d95:84c8]) by smtp.gmail.com with ESMTPSA id s13sm5410969wmc.47.2021.09.15.14.04.27 (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 15 Sep 2021 14:04:27 -0700 (PDT) From: Marco Wahl To: "Tom Davey" Subject: Re: Bug: doc string for "org-end-of-meta-data" References: <014801d7aa5c$c9057450$5b105cf0$@tomdavey.com> Date: Wed, 15 Sep 2021 23:04:09 +0200 In-Reply-To: <014801d7aa5c$c9057450$5b105cf0$@tomdavey.com> (Tom Davey's message of "Wed, 15 Sep 2021 14:09:10 -0400") Message-ID: <87ilz1360m.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2a00:1450:4864:20::42e; envelope-from=marcowahlsoft@gmail.com; helo=mail-wr1-x42e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) 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, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: 'emacs-org list' Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1631739932; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=00jgPqRo3gaYFpNroB17PcEVGZDyFjQbwFKxnKnWuMw=; b=U84wNgD2ZXyS2OQLZdhVFU9OyjHxXJQ1ZN0uVgJBp3LupBdeOnxfl/Iy5b7Vbamt2+i6EN zc2aySWleDHis0wZGNtmQ5VoFGZyxChbypcarPrKlpa4n22wGwc/jvIMED+xzvhct/6BhR 6uP/DbSQdieGA1SNqUJulqv9ol9zvY+ScWJA7RS5D7wofaT3g/2B9A33zYUwxg2/70SzAN O0TbSlpApRqf2AQ2SHGIH0KVNeeR4zwlOAkBRzNEVtU/wfSjqusIHVrooGcNukEm/kHG6v wcRS+eabHGxbhAzZEqndQqmmBYOL+qG7k8A8TrPVwzwWXhsCLOJxRP2Vks6P7A== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1631739932; a=rsa-sha256; cv=none; b=cHNfHJnaZbv9CXbUKm+qglegchv3QHU1MQ0xRe+b3YQRGC27NTiCTfROHzi1wXTEsqcy9J uCcft8PGryBmRRyxnj6q/PMKnWuQZnstpAXGy7JbCuMWg5L8l1LIfIXGjWhXHQ2uPN57E9 TejIlChxcsnMcN1OkYGhwifwbafdWFS8Xx4xCfcgkR9Jz31h+aRFu57HCD4uu1NVkq/U+J N0IrfQQN7hsCEVHMbHpuHXNUrdaMj5U4SywbiwnJNbGAokKCzePPd8M/b5Be/xbtO+p0Wd rIOWeksYwDk5+QlsJRQ583QrxR55llPiylf8bwcbkfM9nJKb8FBxX5RwO0TFzg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=D+9NnDvh; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -1.30 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=D+9NnDvh; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: 354F9B727 X-Spam-Score: -1.30 X-Migadu-Scanner: scn1.migadu.com X-TUID: CQ700032WMuA Hello Tom, > I believe the last paragraph of the doc string for the function > "org-end-of-meta-data" contains an error. That one-sentence paragraph > currently reads: > > When FULL is non-nil but not t, skip planning information, > clocking lines and only non-regular drawers, i.e. properties > and logbook drawers. > > I believe that should be "regular drawers," not "non-regular drawers." IMO, > the last paragraph could be clearer were it rewritten as follows: > > When FULL is non-nil but not t, skip only planning information, > clocking lines and regular drawers, i.e. properties and logbook > drawers. If any non-regular drawers exist and do not follow the > two regular drawers, stop at the first non-regular drawer instead. > > I believe that this expansion of the paragraph corrects the error and adds > coverage of a rare case. I think the use of the word "regular" is not a good idea in their documentation of org-end-of-meta-data. I could not find any occurance of the term "regular drawer" in the org-info manual. There is a section where the property drawer is called "special". In conclusion I'd say that the logic of the recent documentation is okay with "regular" meaning "non-special". Finally I propose to remove completely the categorisation due to "regular" from the documentation. Which reads: When FULL is non-nil but not t, skip planning information, properties, clocking lines and logbook drawers. WDYT?