unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Martin Becze <mjbecze@riseup.net>
Cc: 39931@debbugs.gnu.org
Subject: [bug#39931] [PATCH] gnu: Added emacs-org-journal
Date: Thu, 05 Mar 2020 21:18:52 +0100	[thread overview]
Message-ID: <87a74uk11v.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <20200305174723.15314-1-mjbecze@riseup.net> (Martin Becze's message of "Thu, 5 Mar 2020 12:47:23 -0500")

Hello,

Martin Becze <mjbecze@riseup.net> writes:

> * gnu/packages/emacs-xyz.scm (emacs-org-journal): New Variable.

Thank you!

> +(define-public emacs-org-journal
> +  (package
> +    (name "emacs-org-journal")
> +    (version "2.0.0")
> +    (home-page "https://github.com/bastibe/org-journal")

Usually, `home-page' is lower in the package definition, right above `synopsis'.

> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri (git-reference
> +             (url home-page)

It may be just me, but I'm not a big fan of this trick, because it binds
two information that might be unrelated at some point. I suggest to use
the full URL instead.

OTOH, the above is not a strong argument either, so it's up to you.

> +             (commit version)))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "18dqd0jy2x530lk0h4fcn9cld9qh4w7b3vxa60fpiia628vsv1dg"))))
> +    (build-system emacs-build-system)
> +    (synopsis "A simple org-mode based journaling mode")

I suggest "Simple Org mode based journaling mode". In any case, I think
"guix lint" complains when a synopsis starts with an article.

> +    (description "@code{org-journal} maintains a set of files, depending on the value
> + of @{org-journal-file-type}, a file represents a day, week, month or year. When
> +@code{org-journal-file-type} is set to =’daily=, each file represent a day. In case
> +@{org-journal-file-type} is set to =’weekly=, a file represents
> a week, etc.

"Org Journal maintains a set of files, which may represent a day,
a week, a month or a year."

IOW, I think description should not leak the innards of the package.

> + Convenient bindings allow the creation of journal records in the current daily,
> + weekly, monthly or yearly file and search within all records or specified time
> + intervals. All records can be browsed and searched from the Emacs Calendar for
> + convenience.")

You need to add two spaces after full stops.

Could you send an updated patch?

Regards,

-- 
Nicolas Goaziou

  reply	other threads:[~2020-03-05 20:20 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-05 17:47 [bug#39931] [PATCH] gnu: Added emacs-org-journal Martin Becze
2020-03-05 20:18 ` Nicolas Goaziou [this message]
2020-03-06 16:05   ` Martin Becze
2020-03-07 18:23     ` Martin Becze
2020-03-08 10:24       ` bug#39931: " Nicolas Goaziou

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://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a74uk11v.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=39931@debbugs.gnu.org \
    --cc=mjbecze@riseup.net \
    /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/guix.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).