unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Juanma Barranquero <lektu@terra.es>
Cc: monnier+gnu/emacs@rum.cs.yale.edu, emacs-devel@gnu.org
Subject: Re: Lowercase text after full stop on describe-variable
Date: Thu, 27 Jun 2002 10:54:56 +0200	[thread overview]
Message-ID: <20020627085430.35CF.LEKTU@terra.es> (raw)
In-Reply-To: <200206251107.g5PB75a27123@aztec.santafe.edu>

I've commited the patch to `describe-function' (`describe-function-1',
really) to show obsolescence information like `describe-variable' does
now.

Still, any kind of decision is needed about the issue of formatting of
the documentation. Currently there's a mismatch between the describe-*
functions and `byte-compile-obsolete'. The three of them write an
obsolete message and then the NEW info (NEW as in the argument to
`make-obsolete' and `make-obsolete-variable', I mean). But the
describe-* functions do it after a full stop, while `byte-compile-obsolete'
does it after a semicolon.

Example output from `describe-variable':

> post-command-idle-delay's value is 100000
> 
> Documentation:
> This variable is obsolete since before 19.34.
> use timers instead, with `run-with-idle-timer'.
> Delay time before running `post-command-idle-hook'.
> This is measured in microseconds.

Example output from `byte-compile-obsolete':

> c:/usr/wrk/pru.el: In toplevel form
> c:/usr/wrk/pru.el:1:7: warning: post-command-idle-delay is an obsolete variable since before 19.34; use timers instead, with `run-with-idle-timer'.

I think the best answer would be to put all obsolete info
non-capitalized and then make the describe-* functions capitalize it on
the fly.

Opinions?


                                                           /L/e/k/t/u

  reply	other threads:[~2002-06-27  8:54 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2002-06-24 13:49 Lowercase text after full stop on describe-variable Juanma Barranquero
2002-06-24 15:23 ` Stefan Monnier
2002-06-24 16:03   ` Juanma Barranquero
2002-06-24 16:29   ` Juanma Barranquero
2002-06-24 20:20     ` Stefan Monnier
2002-06-25  9:37       ` Juanma Barranquero
2002-06-25 14:20         ` Stefan Monnier
2002-06-25 17:04           ` Juanma Barranquero
2002-06-25 11:07     ` Richard Stallman
2002-06-27  8:54       ` Juanma Barranquero [this message]
2002-06-27 14:24         ` Stefan Monnier
2002-06-27 16:27           ` Juanma Barranquero
2002-06-27 16:44             ` Stefan Monnier
2002-06-27 19:14             ` Colin Walters
2002-06-28  6:41               ` Juanma Barranquero

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=20020627085430.35CF.LEKTU@terra.es \
    --to=lektu@terra.es \
    --cc=emacs-devel@gnu.org \
    --cc=monnier+gnu/emacs@rum.cs.yale.edu \
    /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).