From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id 2Dh9NePtcmNgVQEAbAwnHQ (envelope-from ) for ; Tue, 15 Nov 2022 02:39:47 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id YNZmNePtcmNrDQAA9RJhRA (envelope-from ) for ; Tue, 15 Nov 2022 02:39:47 +0100 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 A25A13BCD2 for ; Tue, 15 Nov 2022 02:39:47 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oukuZ-0003H9-I6; Mon, 14 Nov 2022 20:38:52 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ouktz-0002rZ-AV for emacs-orgmode@gnu.org; Mon, 14 Nov 2022 20:38:22 -0500 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ouktv-0003O0-VN for emacs-orgmode@gnu.org; Mon, 14 Nov 2022 20:38:14 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 1080F240101 for ; Tue, 15 Nov 2022 02:38:08 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1668476289; bh=wJPEq1Gn6gctOtOUQP0/N57la+ZxybAHrqj4GzLFYLo=; h=From:To:Cc:Subject:Date:From; b=LVosht3cv7b2FbTMx9VUJkpnHJwIkWuD8Y6jyV417RaR/rnX+72Kr6cbJiBBT0lWO H7RzuZQlTMlFJwaRcpwTj9d1rce5kXUjMrUFPl6vzifjV4OzRSkZGzM59SB9mSPB7T mTa3GkTFgH6sipyhQ2LDwB/NzHEOrNxO18w7jyxBXowZFKNOQdeh498/mQW/uEG3vS d+TnaX9wXcJ9QItWX8JnOmuPElm/3mIhXVOQPbdBPKZaU9wB9sDEVCA4FSJIPMHub8 mDho7FRw5rI7FtDfqdW8mHMxbndiueoinX7UnKNHwRJjSf/bm3zT6fgq8Br9gZFnW/ rSHR8d2GfU7Nw== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4NB82Q4G4lz9rxF; Tue, 15 Nov 2022 02:38:06 +0100 (CET) From: Ihor Radchenko To: Uwe Brauer Cc: emacs-orgmode@gnu.org Subject: Re: org-clock-report on headings and subheadings or for the whole file? In-Reply-To: <87h6z2c8pf.fsf@mat.ucm.es> References: <87r0y8ha9g.fsf@mat.ucm.es> <8735an8n3l.fsf@localhost> <87leoffi1y.fsf@mat.ucm.es> <87bkpbfhki.fsf@mat.ucm.es> <87r0y7710r.fsf@localhost> <87sfine1mr.fsf@mat.ucm.es> <87edu6f8s0.fsf@localhost> <87h6z2c8pf.fsf@mat.ucm.es> Date: Tue, 15 Nov 2022 01:38:47 +0000 Message-ID: <87wn7xdmjc.fsf@localhost> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de 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, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, 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.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1668476387; 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=DYzHlfrfykcHVEcMj4wyfaAkvhGrTPr6oys4FW5NsbY=; b=HtGANS9+o0cHisPsablPdiiwLSj77Fq34SxJffXkGL96HnWDXzkc/gGxKCPuG/haz316Fp gXsrnFtRhPTZWTzOKMP2LjS3fIGlUy2B+NMCKxnPNei4PKbRZsX169gaIGGSmqEToM1cQ6 y7AwGPQ6R446gdy2xOPz4HMkdWLjKECnE6LBHa7CmNFmHV7fYG+4lEE45f8D3y3rq9mgsI 7J19elyG6JhDSe8iQX1s//0aVRcKV1joIsMbY9pUTMoO7nRLicOfwUvlImT7bk1jqPPS2B DKw4hxm2bZgew9F79r6AQ4ko/UizxEDlyblWJ1ScczowQA6ZFqVogYS3PWMa+g== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1668476387; a=rsa-sha256; cv=none; b=mRkDqnbiy23ZN8i7Y8OqybjcXV2F/nvwx3z/AnyNHNmgYbXF6yDMl4oA2oiKIPLA73DLQ3 DboVA2sosNQSn2VhrlbV5vLn44Imn6RQ1bGRpIJFwMfc3bRN9Eq3IxrgcCCzQAGpIsEeUH /avBcsQiO7ry+ftH8hFofaK1Cfrh0yOLXY4LLtHC8t6oKVsPx0qWOuzyBPNXlgIAgg+m27 eRgpo5hjGx1Lornjj7HB5nPwKvsqt9K5Ps+Bdvxl72YTMsJVTpP0Yxl1TMAAtFemyTMcAM CiUclpTlVzC1Te6su/fAH1xA8Tjh6g3hpi2jrnd6bkiOLscjX6JHrUnwIp4c7Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=LVosht3c; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -3.84 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=LVosht3c; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: A25A13BCD2 X-Spam-Score: -3.84 X-Migadu-Scanner: scn0.migadu.com X-TUID: tqYm9rYAAyEM --=-=-= Content-Type: text/plain Uwe Brauer writes: >> This information is already in the docstring > >> The new table inherits its properties from the variable >> org-clock-clocktable-default-properties. The scope of the >> clocktable, when not specified in the previous variable, is >> subtree when the function is called from within a subtree, and >> file elsewhere. > >> Or do you think it can be expressed better? > > It is the term *subtree* that I find confusing. > > > * Introduction > ** Details > > <-- that is for me within a subtree > > * Introduction > * Details > > <-- that is for me within a tree > > So why not > > The scope of the clocktable, when not specified in the previous > variable, is subtree when the function is called from within a subtree > or tree and file elsewhere. So if you want a clocktable for the whole > file, you should call the function before the first heading. What about the attached patch? --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-org-clock-report-Improve-docstring.patch >From a5dff6d46044db868dd95f6b57c28dffb202c308 Mon Sep 17 00:00:00 2001 Message-Id: From: Ihor Radchenko Date: Tue, 15 Nov 2022 09:35:47 +0800 Subject: [PATCH] org-clock-report: Improve docstring * lisp/org-clock.el (org-clock-report): Clarify :scope when called from inside a heading or before first heading. Separate :scope description into a separate paragraph. Reported-by: Uwe Brauer Link: https://orgmode.org/list/87h6z2c8pf.fsf@mat.ucm.es --- lisp/org-clock.el | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lisp/org-clock.el b/lisp/org-clock.el index 9dacc050d..604b5481c 100644 --- a/lisp/org-clock.el +++ b/lisp/org-clock.el @@ -2146,10 +2146,12 @@ (defun org-clock-report (&optional arg) Otherwise, insert a new one. The new table inherits its properties from the variable -`org-clock-clocktable-default-properties'. The scope of the -clocktable, when not specified in the previous variable, is -`subtree' when the function is called from within a subtree, and -`file' elsewhere. +`org-clock-clocktable-default-properties'. + +The scope of the clocktable, when not specified in the previous +variable, is `subtree' of the current heading when the function is +called from inside heading, and `file' elsewhere (before the first +heading). When called with a prefix argument, move to the first clock table in the buffer and update it." -- 2.35.1 --=-=-= Content-Type: text/plain -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at --=-=-=--