all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* emacs manual checking attempt
@ 2004-10-22 19:01 Joakim Verona
  0 siblings, 0 replies; only message in thread
From: Joakim Verona @ 2004-10-22 19:01 UTC (permalink / raw)



Hello list,

I tried proofreading one section of the emacs lisp manual.

This is the first time I attempt to do this, so take my suggestions
with a grain of salt.

I simply took the first one not having a reader from
etc/admin/FOR-RELEASE, which was the "Advising Emacs Lisp Functions"
section.


I would appreciate your advice regarding if my comments below are at
all useful for the manual checking effor, or if I should redo something.

Regards, 
/Joakim



** "A simple advice example" 

The example works, but maybe this line could be made more clear:
(setq next-line-add-newlines t) 


** "Defining Advice" 

"classes" doesn't seem complete.  Activation and
deactivation classes are missing

The flag "freeze" is not mentioned.


The below string: 

- Command: ad-unadvise function 

appears rather abruptly, it feels like there is some context missing.

** Around-Advice

     This is not really a variable, but it is somewhat used like one
in around-advice

The above sentence feels insecure, some more definitive language
should be used like "this is used like a place-holder that will be
substituted..."

** activation of advice

This paragraph feels unnecessarily cluttered:

   To activate advice for a function whose advice is already active is
not a no-op.  It is a useful operation which puts into effect any
changes in that function's advice since the previous activation of
advice for that function.


In the description for User Option ad-default-compilation-action: the
possible value 'never' is not described.

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2004-10-22 19:01 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2004-10-22 19:01 emacs manual checking attempt Joakim Verona

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.