Re: [O] map function definitions to org src blocks?

[John Kitchin]

It looks like it is possible to get describe-func to point to an org-file.  Suppose I have a file /Users/jkitchin/vc/journal/2018/11/09/2018-11-09.org that has src blocks that tangle to /Users/jkitchin/vc/journal/2018/11/09/test.el. When test.el is loaded, it adds a bunch of stuff to the variable load-history that describe-function can use to get information. For example:

#+BEGIN_SRC emacs-lisp

(assoc "/Users/jkitchin/vc/journal/2018/11/09/test.el" load-history)

#+END_SRC

#+RESULTS:

: (/Users/jkitchin/vc/journal/2018/11/09/test.el (defun . some-func))

One solution is to just change the file name in load-history like this.

#+BEGIN_SRC emacs-lisp

(setf (car (assoc "/Users/jkitchin/vc/journal/2018/11/09/test.el" load-history)) "/Users/jkitchin/vc/journal/2018/11/09/2018-11-09.org")

#+END_SRC

John

Something like this could be handled in an :after advice for example.

This is only lightly tested... I don't know if it has other implications.

-----------------------------------
Professor John Kitchin 
Doherty Hall A207F
Department of Chemical Engineering
Carnegie Mellon University
Pittsburgh, PA 15213
412-268-7803

@johnkitchin
http://kitchingroup.cheme.cmu.edu

On Thu, Nov 8, 2018 at 10:22 PM Matt Price <address@hidden> wrote:

THanks John. I guess I should always just start my search for "something cool I saw" in scimax...

Yes, thisis pretty great. I havebeen using ~helpful~ which hasa nice interface for some extra functions, but these functions do most of what I felt was missing. 

On Thu, Nov 8, 2018 at 6:02 PM John Kitchin <address@hidden> wrote:

I wrote something kind of like this at 

https://github.com/jkitchin/scimax/blob/master/scimax-literate-programming.el 

It might solve a different problem related to navigating code embedded in org files.

I don't think it works on describe-function. That would be an interesting addition perhaps. I guess though that describe-function would go to the elisp code. I never figured out how to get links in the tangled code to jump back to the org file though. 

On Thu, Nov 8, 2018 at 5:39 PM Matt Price <address@hidden> wrote:

I feel like I saw someone do this but can't find it in my notes. When tangling code to elisp, is it possible to point ~describe-function~ to the original org-mode source (or at least the src block) as the "source code" for the function, rather than the resultant .e file produced by org-babel-tangle? Seems like this would make a whole lot of things significantly easier when writing emacs inits, for instnace.  

--

John

-----------------------------------
Professor John Kitchin 
Doherty Hall A207F
Department of Chemical Engineering
Carnegie Mellon University
Pittsburgh, PA 15213
412-268-7803

@johnkitchin
http://kitchingroup.cheme.cmu.edu