unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: Nobuyoshi Nakada <nobu@ruby-lang.org>
Cc: emacs-devel@gnu.org
Subject: Re: contribution of ruby-mode.el
Date: Sun, 03 Jun 2007 17:27:50 -0400	[thread overview]
Message-ID: <E1Huxc6-000669-OO@fencepost.gnu.org> (raw)
In-Reply-To: <200706021912.l52JC7DD018615@sharui.nakada.kanuma.tochigi.jp> (message from Nobuyoshi Nakada on Sun, 03 Jun 2007 04:12:07 +0900)

To make this program understandable and maintainable, please give
every defconst and every defun a doc string that explains what jobs
they do.  Large functions such as ruby-calculate-indent need a comment
to explain every group of lines.  Maintaining Emacs is hard already,
and if we don't want to make it harder, we need to ensure that new
files are really clear.

It would also be good to add comments at the top of the file
decribing the features that the mode provides.

    (cond
     ((featurep 'font-lock)
      (or (boundp 'font-lock-variable-name-face)
	  (setq font-lock-variable-name-face font-lock-type-face))

      (setq ruby-font-lock-syntactic-keywords

Please delete that cond, and put all the contents at top level.

  parent reply	other threads:[~2007-06-03 21:27 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-02 19:12 contribution of ruby-mode.el Nobuyoshi Nakada
2007-06-03  9:02 ` Stefan Monnier
2007-06-03 21:27 ` Richard Stallman [this message]
2007-10-05 19:29   ` Glenn Morris
  -- strict thread matches above, loose matches on Subject: below --
2007-10-07 23:01 Seiji Zenitani
2007-10-08  7:08 ` Glenn Morris
2007-10-09  1:14 ` Richard Stallman
2007-10-13  2:54   ` Seiji Zenitani
2007-10-13 14:14     ` Richard Stallman
2007-10-13 19:51       ` Glenn Morris
2007-10-13 23:47         ` Seiji Zenitani
2007-10-15  1:36         ` Richard Stallman
2007-10-25  4:09           ` Glenn Morris
2007-10-26  3:49             ` Richard Stallman
2007-10-26 21:06               ` Seiji Zenitani

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/emacs/

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

  git send-email \
    --in-reply-to=E1Huxc6-000669-OO@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=nobu@ruby-lang.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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.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).