emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Kevin Foley <kevin@kevinjfoley.me>
To: emacs-orgmode@gnu.org
Subject: Org Refile RFLOC and Struct Type
Date: Tue, 13 Oct 2020 10:41:37 -0400	[thread overview]
Message-ID: <m2sgai5gta.fsf@Kevins-MBP.home.lan> (raw)

I was recently working with `org-refile` and wanted to use a custom
target.  There is the `rfloc` argument which is documented as:

> RFLOC can be a refile location obtained in a different way.

There's no documentation as to how `rfloc` should be structured.  To
figure that out one has to read through the code which is made even more
difficult by the fact that the same argument is called `refloc` in
`org-refile--get-location`.

I plan to submit a patch to address this, however I wanted feedback on
whether using a struct type (cl-defstruct) could be an improvement
here before trying to implement it.

It seems using a defined structure would make both the documentation and
code more clear, however I rarely (if ever) have seen structures used in
the elisp code I'm familiar with.  Is there a downside to using struct
types that would make it a poor choice in this case?

Kevin


             reply	other threads:[~2020-10-13 14:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-13 14:41 Kevin Foley [this message]
2020-10-18 20:16 ` Kyle Meyer
2020-10-19  1:50   ` [PATCH] Org Refile Document RFLOC (was: Org Refile RFLOC and Struct Type) Kevin Foley
2020-10-20  4:42     ` Kyle Meyer

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=m2sgai5gta.fsf@Kevins-MBP.home.lan \
    --to=kevin@kevinjfoley.me \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: Org Refile RFLOC and Struct Type' \
    /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

Code repositories for project(s) associated with this 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).