emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Bastien <bzg@gnu.org>
To: Leonard Randall <leonard.a.randall@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Feature Request. org-bibtex-tags-are-keywords inherit tags
Date: Fri, 18 Apr 2014 13:14:23 +0200	[thread overview]
Message-ID: <87tx9qj3e8.fsf@bzg.ath.cx> (raw)
In-Reply-To: <CAMRQoA=WLntzgRpQbRtOhu8_Qavz9EB_Adrxi9LGYTJ-e8ifOA@mail.gmail.com> (Leonard Randall's message of "Fri, 18 Apr 2014 10:02:10 +0100")

Hi Leonard,

thanks for starting this!  A few stylistic comments inline.

Leonard Randall <leonard.a.randall@gmail.com> writes:

> diff --git a/lisp/org-bibtex.el b/lisp/org-bibtex.el
> index ed645e5..848d0e4 100644
> --- a/lisp/org-bibtex.el
> +++ b/lisp/org-bibtex.el
> @@ -270,20 +270,31 @@ with underscores, and characters that are not permitted in org
>  tags will be removed.
>  
>  If t, local tags in an org entry will be exported as a
> -comma-separated string of keywords when exported to bibtex.  Tags
> -defined in `org-bibtex-tags' or `org-bibtex-no-export-tags' will
> -not be exported."
> +comma-separated string of keywords when exported to bibtex. If

Make sure to end sentences with two spaces.

>  (defcustom org-bibtex-no-export-tags nil
>    "List of tag(s) that should not be converted to keywords.
> -This variable is relevant only if `org-bibtex-export-tags-as-keywords' is t."
> +This variable is relevant only if `org-bibtex-tags-are-keywords' is t."
>    :group 'org-bibtex
>    :version "24.1"
>    :type '(repeat :tag "Tag" (string)))

I fixed this docstring from the maint branch, you may need to pull
again and rewrite your changes.

> +(defcustom org-bibtex-inherit-tags nil
> +  "This variable controlls whether inherited tags are included

The first line of the docstring should be a sentence.

> +when converting org tags to bibtex keywords. It is relevant only
> +if `org-bibtex-tags-are-keywords' is t. Tag inheritence itself is
> +controlled by `org-use-tag-inheritence' and
> +`org-exclude-tags-from-inheritence'"

There is a missing fullstop at the end, and missing double-space
between sentences.

> +  :group 'org-bibtex
> +  :version "24.1"
> +  :type 'boolean)

Use 

  :version "25.1"
  :package-version '(Org . "8.3")

here, so that users will know the option is new in Org 8.3 (the next
version that will be released from the master branc) and in Emacs 25.1
(the next Emacs stable version that will contain 8.3.)

Otherwise, the patch looks good.  Please resubmit it from a fresh pull
with the modifications I suggested.

Thanks in advance!

-- 
 Bastien

  reply	other threads:[~2014-04-18 11:14 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-04 10:43 Feature Request. org-bibtex-tags-are-keywords inherit tags Leonard Randall
2014-04-04 11:31 ` Leonard Randall
2014-04-17 14:25   ` Bastien
     [not found]     ` <CAMRQoAnD9W7DpuXp5ELsN2fTBPJ2URS3p3+=ERZxM_ESduXtmQ@mail.gmail.com>
2014-04-18  9:02       ` Leonard Randall
2014-04-18 11:14         ` Bastien [this message]
2014-04-18 13:44           ` Leonard Randall
2014-04-18 14:47             ` Bastien
2014-04-19 13:34               ` Leonard Randall
2014-04-19 14:41                 ` Bastien

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=87tx9qj3e8.fsf@bzg.ath.cx \
    --to=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=leonard.a.randall@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).