From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: Bug: second batch of small documentation problems [9.0 (9.0-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20161102/)] Date: Mon, 07 Nov 2016 01:20:31 +0100 Message-ID: <87twbkkunk.fsf@nicolasgoaziou.fr> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:42562) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1c3Xfs-0000EX-Fk for emacs-orgmode@gnu.org; Sun, 06 Nov 2016 19:20:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1c3Xfr-0005RF-GY for emacs-orgmode@gnu.org; Sun, 06 Nov 2016 19:20:32 -0500 Received: from relay3-d.mail.gandi.net ([2001:4b98:c:538::195]:40341) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1c3Xfr-0005QQ-9l for emacs-orgmode@gnu.org; Sun, 06 Nov 2016 19:20:31 -0500 In-Reply-To: (Jorge Morais Neto's message of "Sun, 6 Nov 2016 10:55:52 -0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Jorge Morais Neto Cc: org mode Hello, Jorge Morais Neto writes: > Finally the second batch I promised. Thank you. > - org-table-convert-region docstring is less complete than the manual\\ > The docstring contains the line: > > #+BEGIN_QUOTE > integer When a number, use that many spaces as field separator > #+END_QUOTE > > > [[info:org#Built-in table editor]] says: > > #+BEGIN_QUOTE > a numeric argument N indicates that at least N consecutive spaces, or > alternatively a TAB will be the separator. > #+END_QUOTE > > In the latter, notice the "or alternatively a TAB". I believe the docs= tring > should be complete, so please add this information. Fixed. > - org-archive-to-archive-sibling ARCHIVE_TIME property\\ > org-archive-to-archive-sibling adds an ARCHIVE_TIME property.This shoul= d be > documented in the docstring Done. > and probably also in the manual. I'm not sure it belongs to the manual, as it is more of an implementation detail. For the time being, I don't add it. > - [[info:org#The very busy C-c C-c key]] > > #+BEGIN_QUOTE > If the current buffer is a capture buffer, close the note and file it. > With a prefix argument, file it, without further interaction, to the > default location. > #+END_QUOTE > > Actually, according to [[info:org#Using capture]] and to my quick test, > C-c C-c restores the original window configuration, /and the effect of = C-u is > to make it also jump to the captured item/. Fixed. > - org-match-sparse-tree=E2=80=99s docstring omits it can also match > properties. Fixed. > - [[info:org#Setting tags]] should inform that tag letters for the single= -key > interface are case-sensitive. In "For this to work well you should ass= ign > unique letters to most of your commonly used tags.", replace "assign un= ique > letters" =E2=86=92 "assign unique letters (case-sensitive)". After "In= this > interface, you can use the following keys:", please write "a-zA-Z" inst= ead of > "a-z". Finally, in the docstring of org-tag-alist, please replace "SEL= ECT is > a character" =E2=86=92 "SELECT is a case-sensitive letter". Done. > - org-capture=E2=80=99s docstring could mention ID creation\\ > org-capture creates an ID property if org-id-link-to-org-use-id is set = to t. > This is already documented in that option=E2=80=99s docstring, but perh= aps it should > also be documented in org-capture=E2=80=99s docstring and [[info:org#Us= ing capture]]. > The reason is that if a user is surprised that org-capture created an ID > property, he will look in org-capture=E2=80=99s docstring or perhaps in= the manual > section. He may not remember to check org-id-link-to-org-use-id=E2=80= =99s > docstring `org-capture' itself doesn't check `org-id-link-to-org-use-id' so it would be confusing to write about it in the docstring. I didn't find an adequate location for this (`org-capture-templates' maybe), so I didn't change anything here. > - org-startup-folded=E2=80=99s docstring misreports the default value of > org-agenda-inhibit-startup. The docstring=E2=80=99s last paragraph nee= d changing. Done. > - org-agenda-todo-ignore-deadlines=E2=80=99 docstring about =E2=80=99far > The documentation of 'far says: > > #+BEGIN_QUOTE > Dont show TODO entries where a deadline has been defined, but the deadl= ine > is not near. This is useful if you dont want to use the todo list to f= igure > out what to do now. > #+END_QUOTE > > I do not understand this reasoning. Fixed. > - I believe that many people use .emacs.d/init.el instead of .emacs. To = better > reflect this reality, should not Org=E2=80=99s manual use the expressio= n "Emacs init > file" instead of ".emacs"? I agree. Done. > - Typos and small corrections: > - Docstring of org-agenda-show-inherited-tags > > #+BEGIN_QUOTE > when the value of org-agenda-use-tag-inheritance has been taken into > account. > #+END_QUOTE > > "has been taken into account." =E2=86=92 "enables tag inheritance for= the given > agenda type." Done. > - Docstring of org-agenda-week-view\\ > In "Switch to daily view for agenda", "daily" =E2=86=92 "weekly". Done. Regards, --=20 Nicolas Goaziou