BUG: coderef labels not stripped when tangling

BUG: coderef labels not stripped when tangling

[Michael Alan Dorman]

Using Org-mode to write in a literate style is a lot of fun.  When I
read about coderef labels, they seemed likely to make it even better.

The only problem is that they aren't stripped during tangling. If you
tangle this:

#+BEGIN_SRC sh -n -r :noweb tangle :shebang #!/bin/sh :tangle tangle-test.sh
echo "Working" (ref:working) 
#+END_SRC

You end up with:

    #!/bin/sh

    echo "Working" (ref:working)

That seems like a bug.

Mike.

Re: BUG: coderef labels not stripped when tangling

[Sebastien Vauban]

Hello Michael,

Michael Alan Dorman wrote:
> Using Org-mode to write in a literate style is a lot of fun.  When I
> read about coderef labels, they seemed likely to make it even better.
>
> The only problem is that they aren't stripped during tangling. If you
> tangle this:
>
> #+BEGIN_SRC sh -n -r :noweb tangle :shebang #!/bin/sh :tangle tangle-test.sh
> echo "Working" (ref:working) 
> #+END_SRC
>
> You end up with:
>
>     #!/bin/sh
>
>     echo "Working" (ref:working)
>
> That seems like a bug.

Or a feature, with the consequence that you should put those refs as comments
(with the appropriate syntax in your language).

But, yes, those comments stay as well in your tangled code, which you may not
like.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: BUG: coderef labels not stripped when tangling

[Michael Alan Dorman]

Hi, Sebastien,

"Sebastien Vauban" <wxhgmqzgwmuf@spammotel.com> writes:
> Or a feature, with the consequence that you should put those refs as comments
> (with the appropriate syntax in your language).

That is an excellent suggestion for resolving my immediate issue that
had not occured to me at all.  It believe it does mean that the
presentation of the code ends up with seemingly empty comments where the
coderefs were, but that's a relatively minor thing.

> But, yes, those comments stay as well in your tangled code, which you may not
> like.

It seems counter-intuitive to me that text that is regarded as
meta-information when rendering for presentation is not treated
similarly when tangling---a needless mismatch between the two processes.

But thanks for your workaround suggestion, I will definitely take
advantage of it.

Mike.

Re: BUG: coderef labels not stripped when tangling

[Sebastien Vauban]

Michael,

Michael Alan Dorman wrote:
> "Sebastien Vauban" <wxhgmqzgwmuf-geNee64TY+gS+FvcfC7Uqw@public.gmane.org> writes:
>> Or a feature, with the consequence that you should put those refs as comments
>> (with the appropriate syntax in your language).
>
> That is an excellent suggestion for resolving my immediate issue that
> had not occured to me at all.  It believe it does mean that the
> presentation of the code ends up with seemingly empty comments where the
> coderefs were, but that's a relatively minor thing.

Glad it helped!

>> But, yes, those comments stay as well in your tangled code, which you may not
>> like.
>
> It seems counter-intuitive to me that text that is regarded as
> meta-information when rendering for presentation is not treated
> similarly when tangling---a needless mismatch between the two processes.

I'll let Eric answer on this...

> But thanks for your workaround suggestion, I will definitely take
> advantage of it.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: BUG: coderef labels not stripped when tangling

[Bastien]

Hi Michael,

Michael Alan Dorman <mdorman@ironicdesign.com> writes:

> It seems counter-intuitive to me that text that is regarded as
> meta-information when rendering for presentation is not treated
> similarly when tangling---a needless mismatch between the two
> processes.

I agree this is a bug, and a pretty ugly one I'd say.

I'll have a look in the next days or so, but perhaps
(hopefully!) Eric will beat me up.

Thanks for reporting this!

-- 
 Bastien

Re: BUG: coderef labels not stripped when tangling

[Bastien]

Hi Michael,

Michael Alan Dorman <mdorman@ironicdesign.com> writes:

> Using Org-mode to write in a literate style is a lot of fun.  When I
> read about coderef labels, they seemed likely to make it even better.
>
> The only problem is that they aren't stripped during tangling. If you
> tangle this:
>
> #+BEGIN_SRC sh -n -r :noweb tangle :shebang #!/bin/sh :tangle tangle-test.sh
> echo "Working" (ref:working) 
> #+END_SRC
>
> You end up with:
>
>     #!/bin/sh
>
>     echo "Working" (ref:working)
>
> That seems like a bug.

Indeed.  This show now be fixed (both in maint and master).
Please let us know if not.

Thanks a lot for reporting this nasty bug!

-- 
 Bastien

Re: BUG: coderef labels not stripped when tangling

[Michael Alan Dorman]

Bastien,

> Indeed.  This show now be fixed (both in maint and master).
> Please let us know if not.

Thanks so much for this and all the work you do on org.  I've finally
taken the plunge to learn emacs lisp, so perhaps before long I'll be
able to contribute as well. ;)

Mike.