unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 19628@debbugs.gnu.org
Subject: bug#19628: 25.0.50; doc of button functions
Date: Tue, 20 Jan 2015 10:51:20 -0800 (PST)	[thread overview]
Message-ID: <5d8b8ef5-b579-4984-b5c6-1159205b3974@default> (raw)
In-Reply-To: <<83r3upwc4f.fsf@gnu.org>>

> > The doc of `make-button', `insert-button', and `insert-text-button' just
> > mentions "a sequence of PROPERTY VALUE pairs, specifying properties to
> > add to the button", without saying anything about the text properties
> > that are special for these functions.  This is true for both the doc
> > strings and the Elisp manual (node `Making Buttons').
> 
> The node "Making Buttons" in the ELisp manual has a cross-reference to
> "Button Properties", where all the properties are described.

OK, scratch the part about "true for both the doc strings and the Elisp
manual (node `Making Buttons')".  I somehow missed that xref.

The problem exists for the doc strings, however.

> > Property `action' is mentioned for function `button-activate'
> > (e.g. nodes `Button Properties', `Manipulating Buttons', and `Button
> > Buffer Commands').  But it and any other properties specific to the
> > button functions should be called out where we speak of such properties.
> > Or else such doc should refer to some location where we do specify such
> > properties.
> 
> Sorry, I don't understand what you find missing in the manual.  Where
> the ELisp manual talks about PROPERTY VALUE pairs it immediately
> refers to "Button Properties", where you find the details.  What else
> is needed in the manual?

As I said, in `Manipulating Buttons', for example, the description of
`button-activate' refers to "BUTTON's `action' property".  That property
is not explained there, so there should be a cross-ref from there to the
place where it is described: `Button Properties'.

> > What's more, the doc strings of `push-button' and `button-activate' need
> > to mention property `action', just as the Elisp doc for them does.  It
> > is not sufficient for the doc strings to simply refer to the  "normal
> > action" of the button, without saying what that means.
> 
> button-activate already mentioned the property; I fixed the doc string
> of push-button.

Thanks.





       reply	other threads:[~2015-01-20 18:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<bed57afd-b4b7-447b-aa22-61f6c376ef69@default>
     [not found] ` <<83r3upwc4f.fsf@gnu.org>
2015-01-20 18:51   ` Drew Adams [this message]
2015-01-20 19:23     ` bug#19628: 25.0.50; doc of button functions Eli Zaretskii
     [not found] <<5d8b8ef5-b579-4984-b5c6-1159205b3974@default>
     [not found] ` <<83iog1w91t.fsf@gnu.org>
2015-01-20 19:29   ` Drew Adams
2015-01-19 16:20 Drew Adams
2015-01-20 18:17 ` Eli Zaretskii

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=5d8b8ef5-b579-4984-b5c6-1159205b3974@default \
    --to=drew.adams@oracle.com \
    --cc=19628@debbugs.gnu.org \
    --cc=eliz@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.
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).