emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jude DaShiell <jdashiel@panix.com>
To: Uwe Brauer <oub@mat.ucm.es>, emacs-orgmode@gnu.org
Subject: Re: how to document/comment a complex org table formula
Date: Mon, 5 Jul 2021 13:24:10 -0400	[thread overview]
Message-ID: <alpine.NEB.2.23.451.2107051323100.18053@panix1.panix.com> (raw)
In-Reply-To: <87wnq43cw8.fsf@mat.ucm.es>

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 <jdashiel@panix.com> 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
>


  reply	other threads:[~2021-07-05 17:24 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-04 19:14 how to document/comment a complex org table formula Uwe Brauer
2021-07-05 14:13 ` Eric S Fraga
2021-07-05 14:45   ` Uwe Brauer
2021-07-05 14:55   ` Tim Visher
2021-07-05 15:20     ` Jude DaShiell
2021-07-05 17:10       ` Uwe Brauer
2021-07-05 17:24         ` Jude DaShiell [this message]
2021-07-05 15:39     ` Eric S Fraga
2021-07-05 17:08     ` Uwe Brauer
2021-07-05 17:12 ` Karl Voit
2021-07-05 19:35   ` Uwe Brauer
  -- strict thread matches above, loose matches on Subject: below --
2021-07-05  5:31 CHARPENTIER Emmanuel via General discussions about Org-mode.
2021-07-05  6:29 ` Uwe Brauer
2021-07-08 20:19   ` Nick Dokos

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=alpine.NEB.2.23.451.2107051323100.18053@panix1.panix.com \
    --to=jdashiel@panix.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=oub@mat.ucm.es \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).