all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* Inconsistent use of align/indent comments in info
@ 2006-04-07 14:54 Andrew M. Scott
  2006-04-07 21:36 ` Richard Stallman
  0 siblings, 1 reply; 2+ messages in thread
From: Andrew M. Scott @ 2006-04-07 14:54 UTC (permalink / raw)


The info pages seem to inconsistently refer to aligning vs. indenting
comments, as shown by the "^^^^^" marks below. Any fix probably
depends on whether one considers aligning and indenting as
independent, or one as a subset of the other.


C-h i
m emacs
s comments takes you to 

Editing Programs
* Comments::	        Inserting, killing, and aligning comments.
                                                ^^^^^^^^
Hitting return * Comments above takes you to:

File: emacs,  Node: Comments,  Next: Documentation,  Prev: Parentheses,  Up: Programs

31.5 Manipulating Comments
==========================

Because comments are such an important part of programming, Emacs
provides special commands for editing and inserting comments.  It can
also do spell checking on comments with Flyspell Prog mode (*note
Spelling::).

* Menu:

* Comment Commands::    Inserting, killing, and indenting comments.
                                                ^^^^^^^^^
Hitting return on Comment Commands: takes you to
File: emacs,  Node: Comment Commands,  Next: Multi-Line Comments,  Up: Comments

31.5.1 Comment Commands
-----------------------

The comment commands in this table insert, kill and align comments.
                                                    ^^^^^
Andy Scott

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Inconsistent use of align/indent comments in info
  2006-04-07 14:54 Inconsistent use of align/indent comments in info Andrew M. Scott
@ 2006-04-07 21:36 ` Richard Stallman
  0 siblings, 0 replies; 2+ messages in thread
From: Richard Stallman @ 2006-04-07 21:36 UTC (permalink / raw)
  Cc: emacs-devel

Thanks for pointing out the inconsistency.  "Indentation"
refers to whitespace at the start of a line; thus, in general,
comments are aligned, not indented, but comments that do not
follow code may be described as "indented".  I've corrected
the text to follow that rule.

The command name comment-indent should really be comment-align, and
the variable names c-indent-comment-alist,
c-indent-comments-syntactically-p, and comment-indent-function really
ought to say "align" instead of "indent".  Perhaps we should make
new aliases for them.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2006-04-07 21:36 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-04-07 14:54 Inconsistent use of align/indent comments in info Andrew M. Scott
2006-04-07 21:36 ` Richard Stallman

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.