emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Oleh Krehel <oleh@oremacs.com>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: emacs-org list <emacs-orgmode@gnu.org>
Subject: Re: New package: ox-minutes [Please critique]
Date: Wed, 10 Aug 2016 18:16:07 +0200	[thread overview]
Message-ID: <87fuqctxa0.fsf@oremacs.com> (raw)
In-Reply-To: <CAFyQvY3euwucYoz+RFXbEpBY1dHJ-1Ftrb0WaxT+4vqrfx=Zzg@mail.gmail.com> (Kaushal Modi's message of "Wed, 10 Aug 2016 15:19:14 +0000")

Kaushal Modi <kaushal.modi@gmail.com> writes:

> Hi all,
>
> I have never published a package. I generally write elisp snippets embedded in my config.
>
> Here are my first attempts at a 'package' and defining a custom org
> export backend.

Congrats on your first package! It will surely come in handy when
interacting with my less Emacs-enlightened colleagues. I recall one of
them writing very similar-looking notes in Microsoft Outlook. One or two
times I had to send them some notes, I actually did by hand the
transformation that `ox-minutes' now does.

> I would love to get criticism on this... What did I miss? Bad coding
> practices?

The coding looks fine. Just a suggestion: I think "\n" looks better than
a literal string newline.

It would be cool to have a regression test with:

    ./ox-minutes/ox-minutes-test.el
    ./ox-minutes/test_input.org
    ./ox-minutes/test_output.txt

Both test_input.org and test_output.txt could be moved from README.md.

regards,
Oleh

  reply	other threads:[~2016-08-10 16:16 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-10 15:19 New package: ox-minutes [Please critique] Kaushal Modi
2016-08-10 16:16 ` Oleh Krehel [this message]
2016-08-10 16:29   ` Kaushal Modi

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=87fuqctxa0.fsf@oremacs.com \
    --to=oleh@oremacs.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=kaushal.modi@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).