From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id EO8qK1dA42DC4gAAgWs5BA (envelope-from ) for ; Mon, 05 Jul 2021 19:24:39 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id mGvzJldA42BZJwAA1q6Kng (envelope-from ) for ; Mon, 05 Jul 2021 17:24:39 +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 F16B213FAC for ; Mon, 5 Jul 2021 19:24:38 +0200 (CEST) Received: from localhost ([::1]:43364 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m0SKj-0001fu-7b for larch@yhetil.org; Mon, 05 Jul 2021 13:24:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:32788) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m0SKL-0001fk-AU for emacs-orgmode@gnu.org; Mon, 05 Jul 2021 13:24:13 -0400 Received: from mailbackend.panix.com ([166.84.1.89]:49136) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m0SKJ-0006W3-R3 for emacs-orgmode@gnu.org; Mon, 05 Jul 2021 13:24:13 -0400 Received: from panix1.panix.com (panix1.panix.com [166.84.1.1]) by mailbackend.panix.com (Postfix) with ESMTP id 4GJXbv0C6Mz3l3R; Mon, 5 Jul 2021 13:24:11 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=panix.com; s=panix; t=1625505851; bh=7Tqw6FFA53+HKti7QnLqeMjRcPVVLuW3ShCqn2RG13Q=; h=Date:From:To:Subject:In-Reply-To:References; b=Gl+9YCbn+UffXK+d/8K+Pbh7f5isIgw4aYKXQ66d5nZQ1JTs4vUf1ulKvcOPFTPPA 4xeM8Yq7elPc9d0HYLyMnS1h4OvAnnv15AhMNVO/5KXzkB9q707TohErAOVEsiIY/z BywafIftegEIEjoEUHgZTdy0WvvRRHEjBddKHNV4= Received: by panix1.panix.com (Postfix, from userid 20712) id 4GJXbt69QBzcbc; Mon, 5 Jul 2021 13:24:10 -0400 (EDT) Received: from localhost (localhost [127.0.0.1]) by panix1.panix.com (Postfix) with ESMTP id 4GJXbt5WgvzcbW; Mon, 5 Jul 2021 13:24:10 -0400 (EDT) Date: Mon, 5 Jul 2021 13:24:10 -0400 From: Jude DaShiell To: Uwe Brauer , emacs-orgmode@gnu.org Subject: Re: how to document/comment a complex org table formula In-Reply-To: <87wnq43cw8.fsf@mat.ucm.es> Message-ID: References: <87h7h9c2nw.fsf@mat.ucm.es> <87zgv0alwt.fsf@ucl.ac.uk> <87wnq43cw8.fsf@mat.ucm.es> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Received-SPF: pass client-ip=166.84.1.89; envelope-from=jdashiel@panix.com; helo=mailbackend.panix.com X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=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.23 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" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1625505879; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to: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=zoZo0u7kjBRKJkm2GAypWuwutDJoI2OU4gVuJ3KkIbs=; b=GYLZSO0nFbjO+0xsk6Tybx4Y3qqFT5tsFiB8t+U2oeXIMfsNVFj4oCCmYeoY4vQclZZFCy UHpYXRRUJB342bXkRWmqgljXUhwR37d6jZnBE7gSc7Z7WQJzHmSKytwj8Mj48QgA/Ne/JH vBVGxRsIyGTUIPP1npjdlNh2Vc1XE9VlOqfYQdU5A1sexwa5LVj7AwHvWeQBeLf4HLIQXz aOIhrjbWHRpVgOuouP255m71iEEffSW89EUz/LvSOc4PrZ+AFX/+/JQJqmhVBGYgvBQqms 4iJMZ6/cUi2FRXXaUPe8G8SSpwPAXmAB2n2fqhDbx/Pbj5lAWV1/rIYa6Fk3bg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1625505879; a=rsa-sha256; cv=none; b=iVGQsYEeGt5VtEi1jSwWtvjOzNbaOqzRCS6bbljvjJqZGk7YLlliIKpyITno2/HR7FWupX Ld2eRXlJtMvqBwpqVRJj/2DOKVyzBD6AgE/3JWCKg1NIiH7FIJifhwS1W2F8wFq937KZcG W2i4Vpvi5t/TaUPBzrqezWZYWdTJkxoua5jg3Dd4LZ7UY56L8yTOD5XoUbrPUJCvDyzvl/ +iSzIim3FW8zDSZJuhLLjzOi79ubbZhFmoqykMf7hf/qfMVzQ6B8OQAVxIA1jnuG+U6Ez7 wSmjw/fLwOWe8KP9jePVNmqKWBCf6MDkCsZTDrJfCYKHhJuykWMxxsrzwHdogw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=panix.com header.s=panix header.b=Gl+9YCbn; 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.41 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=panix.com header.s=panix header.b=Gl+9YCbn; dmarc=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: F16B213FAC X-Spam-Score: -1.41 X-Migadu-Scanner: scn1.migadu.com X-TUID: rKBCd5RxSdqk So long as each piece of documentation has a continuation pointer to the next piece of documentation in the chain I think that would work. On Mon, 5 Jul 2021, Uwe Brauer wrote: > >>> "JD" == Jude DaShiell writes: > > > Why not use functional narrative form to document complex formulas? > > formula name: > > formula function: > > formula uses: > > formula returns: > > > That would be also nice, however the problem I am facing to have a long > and complicated expression with a lot of ifs, maybe best practise would > be to split it and distribute it over various column and add comments as > in > > #+begin_src elisp > |----+----+----+---+---+----| > | 1 | 4 | 5 | 3 | 3 | 6 | > | 3 | 12 | 15 | 9 | 2 | 11 | > | 12 | 2 | 14 | 7 | 3 | 10 | > #+TBLFM: $3=vsum($1..$2);f1:: #one comment > #+TBLFM: $6=vsum($4..$5);f1:: #second comment > #+end_src >