emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Org Refile RFLOC and Struct Type
@ 2020-10-13 14:41 Kevin Foley
  2020-10-18 20:16 ` Kyle Meyer
  0 siblings, 1 reply; 4+ messages in thread
From: Kevin Foley @ 2020-10-13 14:41 UTC (permalink / raw)
  To: emacs-orgmode

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


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-10-20  4:43 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-13 14:41 Org Refile RFLOC and Struct Type Kevin Foley
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

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).