[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: incorrect documentation for file-desc header argument?

From: Kyle Meyer
Subject: Re: incorrect documentation for file-desc header argument?
Date: Wed, 29 Jul 2020 01:03:30 -0400

Matt Huszagh writes:

> The org info documentation states
>      The ‘file-desc’ header argument defines the description (see *note
>      Link Format::) for the link.  If ‘file-desc’ has no value, Org uses
>      the generated file name for both the “link” and “description” parts
>      of the link.
> However, if I evaluate the
> #+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
>   size(2cm);
>   draw(unitcircle);
> I get
> [[file:img/circle.pdf]]
> I believe the documentation (and this is corroborated by the discussion
> of the original patch
> (https://lists.gnu.org/archive/html/emacs-orgmode/2012-04/msg00022.html)),
> that the intended result is
> [[file:img/circle.pdf][file:img/circle.pdf]]
> Is my assessment correct? Can anyone else confirm this bug?

Yeah, that looks to be the intended result of that thread.  That
thread's patch was applied with a58a4f0ad (new source block header
argument :filelinkdescr, 2012-03-27).  However, shortly after, that
treatment was intentionally changed (670c7f31c, 2012-03-31):

    simplified implementation of :file-desc header argument
    This will no longer insert the value of the :file header argument as
    the description if the description is left blank (as this changes
    the meaning of the :file header argument).
    The desc handling logic is moved to the `org-babel-result-to-file'

So, I'd say this is a documentation bug.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]