unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: Thien-Thi Nguyen <ttn@gnuvola.org>
To: guile-devel@gnu.org
Subject: two spaces after sentence + other doc janitorial duties
Date: Fri, 25 Jun 2010 18:35:18 +0200	[thread overview]
Message-ID: <87tyorqddl.fsf@ambire.localdomain> (raw)

Normally, texinfo source should have two spaces after each sentence:

   Blah the first. Blah more.      ;; only one space, not cool
   Blah the first.  Blah more.     ;; two spaces, ok

I started locally modifying doc/ref/*.texi, when midway though discovered
api-undocumented.texi, which led me to doc/maint/docstring.el, which leads
me to believe that modifing doc/ref/*.texi is not so smart, since a future
update using docstring.el would overwrite them.  Better to make the changes
upstream (in libguile/*.c SCM_DEFINE forms, to be precise), no?

Further digging, i see one of the last docstring.el-using updates was:

  commit 3323ec063ccc87b210e6da04c57c625af270b230
  Author: Neil Jerram <neil@ossau.uklinux.net>
  Date:   Sun Dec 27 23:24:09 2009 +0000
  
      Automatic manual updates following libguile docstring changes
      
and since then there have been many other manual updates.  So, should i
interpret the six months since that update to mean that we are no longer
using a docstring.el-based system?  Am i missing something?

I suppose a shorter question would be: What do you all suggest for doing
"two spaces" and other doc cleanups -- which source is the true source?

Other changes i have in mind:

 - convert "..." to "@dots{}";
 - convert "i.e. FOO" to "i.e., FOO"
   (and likewise "i. e. FOO" and "e.g. FOO");
 - choose "Returns" or "Return" and use it everywhere;

Last related question: I realize that a subset of the doc/ref/*.texi do
not derive from docstring.el (for example vm.texi), so can be operated
on directly w/o qualms.  How about i collect changes to those files onto
branch ‘ttn/janitor-doc’ and simply post "rfc: SHA1"?  I can't imagine
huge diffs would be welcome on the list...

thi



             reply	other threads:[~2010-06-25 16:35 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-25 16:35 Thien-Thi Nguyen [this message]
2010-06-28 13:57 ` two spaces after sentence + other doc janitorial duties Andy Wingo
2010-07-02 13:23   ` Ludovic Courtès
2010-07-08 10:10     ` Andy Wingo
2010-07-08 17:04       ` dsmich
  -- strict thread matches above, loose matches on Subject: below --
2010-07-12  0:51 Karl Berry
2010-07-13 21:13 ` Andy Wingo

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.gnu.org/software/guile/

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

  git send-email \
    --in-reply-to=87tyorqddl.fsf@ambire.localdomain \
    --to=ttn@gnuvola.org \
    --cc=guile-devel@gnu.org \
    /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.
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).