emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: Ihor Radchenko <yantar92@gmail.com>,
	Daniel Fleischer <danflscr@gmail.com>
Cc: emacs-orgmode@gnu.org, emacs@vergauwen.me
Subject: Re: ox-latex table tabbing support.
Date: Sat, 25 Jun 2022 23:49:31 -0400	[thread overview]
Message-ID: <87k09413uc.fsf@kyleam.com> (raw)
In-Reply-To: <87zgi0tcj6.fsf@localhost>

Ihor Radchenko writes:

> Daniel Fleischer <danflscr@gmail.com> writes:
>
>> Thank you very much for the patch. It was merged to master in 4a0d951c.
>> Also, you were added to the orgmode contributes at
>> https://orgmode.org/worg/contributors.html.
>>
>> Thanks for the contribution.
>
> This commit triggers
>
> In org-latex--align-string-tabbing:
> ox-latex.el:3713:54: Warning: Unused lexical variable `align'
>
> Looking at the code, it does not look like align variable serve any
> purpose. Can someone please double check if the patch is working as
> intended?

Thanks for flagging this, Ihor.  I was just glancing at this commit
(4a0d951c6) due to seeing this warning.  It's doing

  (let ((align ...))
    (setq align ...))

where the align value is returned, so the align binding can be dropped
altogether.

Daniel, in addition to that, there are at least a few other issues with
4a0d951c6 that should be addressed:

 * the first line of the new docstrings should be a complete sentence.

   For example

     Return an appropriate LaTeX alignment string, for the
     latex tabbing environment.

   should be changed to something like

     Return alignment string for LaTeX tabbing environment.

   See (info "(elisp)Documentation Tips")

 * the indentation is off in several places, including the start of the
   docstrings.  Please indent the code with, e.g., indent-region.

 * one of org-table--org-tabbing's parameters is a typo (contenst),
   which it looks like Ihor pointed out in an earlier review

 * comment typo: documets

 * several spots put opening and trailing parentheses on their own line

   That goes against the usual conventions of this repo:

     $ git grep '^ *)' '*.el' | wc -l
     42
     $ git grep '( *$' '*.el' | wc -l
     17

 * rather than doing something like

     (let ((x ""))
       (setq x <something else>)
       ...)

   just do

     (let ((x <something else>))
      ...)

   And consider whether it's worth adding a binding at all rather than
   inlining the code.

   As an extreme case, org-table--org-tabbing does

     (let ((output (format ...)))
       output)

   rather than

     (format ...)


  reply	other threads:[~2022-06-26  3:51 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-28 14:38 ox-latex table tabbing support emacs--- via General discussions about Org-mode.
2022-04-04 10:33 ` Ihor Radchenko
     [not found] ` <87wng5nno3.fsf@localhost-Mzo7eKN----2>
2022-04-04 14:03   ` emacs--- via General discussions about Org-mode.
2022-06-21  4:43     ` Daniel Fleischer
2022-06-24 13:37       ` Robert Pluim
2022-06-24 14:20         ` Daniel Fleischer
2022-06-24 15:01           ` Robert Pluim
2022-06-24 15:50             ` Daniel Fleischer
2022-06-24 19:32             ` emacs--- via General discussions about Org-mode.
2022-06-25  3:32               ` Ihor Radchenko
2022-06-26 10:08                 ` Robert Pluim
2022-06-26 13:47                   ` [PATCH] describe how to override Author Robert Pluim
2022-06-26 14:04                     ` Daniel Fleischer
2022-06-27  9:53                     ` Ihor Radchenko
2022-06-28 12:07                       ` Robert Pluim
2022-06-29 10:10                         ` Ihor Radchenko
2022-06-30  8:18                           ` Robert Pluim
2022-06-30 13:19                             ` Ihor Radchenko
2022-06-30 15:17                               ` Robert Pluim
2022-07-02  4:21                                 ` Ihor Radchenko
2022-06-26  1:54       ` ox-latex table tabbing support Ihor Radchenko
2022-06-26  3:49         ` Kyle Meyer [this message]
2022-06-26 14:46           ` [PATCH] " Daniel Fleischer
2022-06-26 18:18             ` Kyle Meyer
2022-06-26 18:48               ` Daniel Fleischer

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=87k09413uc.fsf@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=danflscr@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=emacs@vergauwen.me \
    --cc=yantar92@gmail.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public 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).