* bug#4188: 23.1; doc strings in bookmark.el
@ 2009-08-19 22:23 ` Drew Adams
2009-10-05 1:45 ` bug#4188: marked as done (23.1; doc strings in bookmark.el) Emacs bug Tracking System
0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2009-08-19 22:23 UTC (permalink / raw)
To: bug-gnu-emacs
1. The function doc strings need to describe the arguments.
For example, these functions (at least) should say,
"BOOKMARK is a bookmark name or a bookmark record."
bookmark-get-bookmark, bookmark-get-bookmark-record,
bookmark-prop-get, bookmark-prop-set, bookmark-get-handler,
bookmark--jump-via, bookmark-jump-noselect.
This is particularly important because some functions expect that
their bookmark argument be a bookmark name, others expect that it be a
bookmark record, and still others allow either.
2. Some functions (e.g. bookmark--jump-via) are missing doc strings
altogether.
In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4296: 23.1; Change bookmark comments to docstring.
@ 2009-08-31 7:45 ` Thierry Volpiatto
2009-10-05 1:45 ` bug#4296: marked as done (23.1; Change bookmark comments to docstring.) Emacs bug Tracking System
0 siblings, 1 reply; 6+ messages in thread
From: Thierry Volpiatto @ 2009-08-31 7:45 UTC (permalink / raw)
To: bug-gnu-emacs
Please write in English if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.
Your bug report will be posted to the bug-gnu-emacs@gnu.org mailing list,
and to the gnu.emacs.bug news group.
Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:
Hi,
many functions in bookmark.el have comments instead of docstring, could
you please fix that.
e.g
,----
| (defun bookmark-maybe-sort-alist ()
| ;;Return the bookmark-alist for display. If the bookmark-sort-flag
| ;;is non-nil, then return a sorted copy of the alist.
`----
If Emacs crashed, and you have the Emacs process in the gdb debugger,
please include the output from the following gdb commands:
`bt full' and `xbacktrace'.
If you would like to further debug the crash, please read the file
/usr/share/emacs/23.1/etc/DEBUG for instructions.
In GNU Emacs 23.1.1 (i686-pc-linux-gnu, GTK+ Version 2.16.5)
of 2009-07-31 on tux
Windowing system distributor `The X.Org Foundation', version 11.0.10503000
configured using `configure '--prefix=/usr' '--build=i686-pc-linux-gnu' '--host=i686-pc-linux-gnu' '--mandir=/usr/share/man' '--infodir=/usr/share/info' '--datadir=/usr/share' '--sysconfdir=/etc' '--localstatedir=/var/lib' '--program-suffix=-emacs-23' '--infodir=/usr/share/info/emacs-23' '--with-sound' '--with-x' '--without-toolkit-scroll-bars' '--with-gif' '--with-jpeg' '--with-png' '--with-rsvg' '--with-tiff' '--with-xpm' '--with-xft' '--without-libotf' '--without-m17n-flt' '--with-x-toolkit=gtk' '--without-hesiod' '--without-kerberos' '--without-kerberos5' '--with-gpm' '--with-dbus' 'build_alias=i686-pc-linux-gnu' 'host_alias=i686-pc-linux-gnu' 'CFLAGS=-march=i686 -pipe -O2' 'LDFLAGS=-Wl,-O1''
Important settings:
value of $LC_ALL: fr_FR.UTF-8
value of $LC_COLLATE: nil
value of $LC_CTYPE: nil
value of $LC_MESSAGES: nil
value of $LC_MONETARY: nil
value of $LC_NUMERIC: nil
value of $LC_TIME: nil
value of $LANG: fr_FR.UTF-8
value of $XMODIFIERS: nil
locale-coding-system: utf-8-unix
default-enable-multibyte-characters: t
Major mode: Lisp Interaction
Minor modes in effect:
eldoc-mode: t
icomplete-mode: t
icicle-mode: t
delete-selection-mode: t
minibuffer-depth-indicate-mode: t
auto-image-file-mode: t
shell-dirtrack-mode: t
partial-completion-mode: t
show-paren-mode: t
display-battery-mode: t
display-time-mode: t
diff-auto-refine-mode: t
outline-minor-mode: t
recentf-mode: t
savehist-mode: t
desktop-save-mode: t
tooltip-mode: t
mouse-wheel-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
font-lock-mode: t
global-auto-composition-mode: t
auto-composition-mode: t
auto-encryption-mode: t
auto-compression-mode: t
line-number-mode: t
transient-mark-mode: t
Recent input:
<right> SPC t o SPC C-M-` C-M-y <down> <return> <right>
. C-c C-c <S-up> C-x C-s C-x C-& <f5> a q <tab> <down>
<down> <down> <down> <down> <return> <down> <return>
<f11> a <down> <down> <down> <down> <return> g <down>
C-c I <down> <return> <f11> & <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> M f <up> M p <f11> & <f11> a <down>
<down> <down> <down> <return> g C M-p M-p M-p M-p M-p
M-p M-p <return> y <f11> a <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<return> b y <up> <up> u g L y C-x C-& C-x r l <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <return>
C-g C-x r l <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> C-o o C-g <S-up> C-x C-& t t q M-x s
e n d <tab> <backspace> <backspace> <backspace> <backspace>
<backspace> <backspace> <backspace> <backspace> <backspace>
<backspace> <backspace> <backspace> <backspace> <backspace>
C-g <f5> a p b b u u g g C-g M-x s u b m i <tab> <tab>
<backspace> <backspace> <backspace> <backspace> <backspace>
C-g <f5> a p b u u g g <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> C-g M-x r e p o r t <tab> <down> <re
turn>
Recent messages:
Load: 1 file.
Region is from 67 to 327
Quit
Region is from 67 to 327 [2 times]
Quit
Computing completion candidates...
Computing completion candidates... [2 times]
Computing completion candidates...
--
A + Thierry Volpiatto
Location: Saint-Cyr-Sur-Mer - France
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4188: marked as done (23.1; doc strings in bookmark.el)
2009-08-19 22:23 ` bug#4188: 23.1; doc strings in bookmark.el Drew Adams
@ 2009-10-05 1:45 ` Emacs bug Tracking System
2009-10-10 18:17 ` Drew Adams
0 siblings, 1 reply; 6+ messages in thread
From: Emacs bug Tracking System @ 2009-10-05 1:45 UTC (permalink / raw)
To: Karl Fogel
[-- Attachment #1: Type: text/plain, Size: 847 bytes --]
Your message dated Sun, 04 Oct 2009 21:36:31 -0400
with message-id <87y6nqmxk0.fsf@red-bean.com>
and subject line Fixed "doc strings in bookmark.el"
has caused the Emacs bug report #4188,
regarding 23.1; doc strings in bookmark.el
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)
--
4188: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4188
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems
[-- Attachment #2: Type: message/rfc822, Size: 3519 bytes --]
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: 23.1; doc strings in bookmark.el
Date: Wed, 19 Aug 2009 15:23:50 -0700
Message-ID: <93AC19018012425A8D3A6E2163301F3A@us.oracle.com>
1. The function doc strings need to describe the arguments.
For example, these functions (at least) should say,
"BOOKMARK is a bookmark name or a bookmark record."
bookmark-get-bookmark, bookmark-get-bookmark-record,
bookmark-prop-get, bookmark-prop-set, bookmark-get-handler,
bookmark--jump-via, bookmark-jump-noselect.
This is particularly important because some functions expect that
their bookmark argument be a bookmark name, others expect that it be a
bookmark record, and still others allow either.
2. Some functions (e.g. bookmark--jump-via) are missing doc strings
altogether.
In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
[-- Attachment #3: Type: message/rfc822, Size: 1609 bytes --]
From: Karl Fogel <kfogel@red-bean.com>
To: 4188-close@emacsbugs.donarmstrong.com
Subject: Fixed "doc strings in bookmark.el"
Date: Sun, 04 Oct 2009 21:36:31 -0400
Message-ID: <87y6nqmxk0.fsf@red-bean.com>
fixed
--
Thanks for the report. Fix committed:
$ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
/sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el
new revision: 1.128; previous revision: 1.127
/sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog
new revision: 1.16354; previous revision: 1.16353
Mailing notification to emacs-diffs@gnu.org... sent.
$
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4296: marked as done (23.1; Change bookmark comments to docstring.)
2009-08-31 7:45 ` bug#4296: 23.1; Change bookmark comments to docstring Thierry Volpiatto
@ 2009-10-05 1:45 ` Emacs bug Tracking System
0 siblings, 0 replies; 6+ messages in thread
From: Emacs bug Tracking System @ 2009-10-05 1:45 UTC (permalink / raw)
To: Karl Fogel
[-- Attachment #1: Type: text/plain, Size: 859 bytes --]
Your message dated Sun, 04 Oct 2009 21:36:31 -0400
with message-id <87y6nqmxk0.fsf@red-bean.com>
and subject line Fixed "doc strings in bookmark.el"
has caused the Emacs bug report #4188,
regarding 23.1; Change bookmark comments to docstring.
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)
--
4188: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4188
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems
[-- Attachment #2: Type: message/rfc822, Size: 9381 bytes --]
From: Thierry Volpiatto <thierry.volpiatto@gmail.com>
To: bug-gnu-emacs@gnu.org
Subject: 23.1; Change bookmark comments to docstring.
Date: Mon, 31 Aug 2009 09:45:53 +0200
Message-ID: <8763c4xw7i.fsf@tux.homenetwork>
Please write in English if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.
Your bug report will be posted to the bug-gnu-emacs@gnu.org mailing list,
and to the gnu.emacs.bug news group.
Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:
Hi,
many functions in bookmark.el have comments instead of docstring, could
you please fix that.
e.g
,----
| (defun bookmark-maybe-sort-alist ()
| ;;Return the bookmark-alist for display. If the bookmark-sort-flag
| ;;is non-nil, then return a sorted copy of the alist.
`----
If Emacs crashed, and you have the Emacs process in the gdb debugger,
please include the output from the following gdb commands:
`bt full' and `xbacktrace'.
If you would like to further debug the crash, please read the file
/usr/share/emacs/23.1/etc/DEBUG for instructions.
In GNU Emacs 23.1.1 (i686-pc-linux-gnu, GTK+ Version 2.16.5)
of 2009-07-31 on tux
Windowing system distributor `The X.Org Foundation', version 11.0.10503000
configured using `configure '--prefix=/usr' '--build=i686-pc-linux-gnu' '--host=i686-pc-linux-gnu' '--mandir=/usr/share/man' '--infodir=/usr/share/info' '--datadir=/usr/share' '--sysconfdir=/etc' '--localstatedir=/var/lib' '--program-suffix=-emacs-23' '--infodir=/usr/share/info/emacs-23' '--with-sound' '--with-x' '--without-toolkit-scroll-bars' '--with-gif' '--with-jpeg' '--with-png' '--with-rsvg' '--with-tiff' '--with-xpm' '--with-xft' '--without-libotf' '--without-m17n-flt' '--with-x-toolkit=gtk' '--without-hesiod' '--without-kerberos' '--without-kerberos5' '--with-gpm' '--with-dbus' 'build_alias=i686-pc-linux-gnu' 'host_alias=i686-pc-linux-gnu' 'CFLAGS=-march=i686 -pipe -O2' 'LDFLAGS=-Wl,-O1''
Important settings:
value of $LC_ALL: fr_FR.UTF-8
value of $LC_COLLATE: nil
value of $LC_CTYPE: nil
value of $LC_MESSAGES: nil
value of $LC_MONETARY: nil
value of $LC_NUMERIC: nil
value of $LC_TIME: nil
value of $LANG: fr_FR.UTF-8
value of $XMODIFIERS: nil
locale-coding-system: utf-8-unix
default-enable-multibyte-characters: t
Major mode: Lisp Interaction
Minor modes in effect:
eldoc-mode: t
icomplete-mode: t
icicle-mode: t
delete-selection-mode: t
minibuffer-depth-indicate-mode: t
auto-image-file-mode: t
shell-dirtrack-mode: t
partial-completion-mode: t
show-paren-mode: t
display-battery-mode: t
display-time-mode: t
diff-auto-refine-mode: t
outline-minor-mode: t
recentf-mode: t
savehist-mode: t
desktop-save-mode: t
tooltip-mode: t
mouse-wheel-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
font-lock-mode: t
global-auto-composition-mode: t
auto-composition-mode: t
auto-encryption-mode: t
auto-compression-mode: t
line-number-mode: t
transient-mark-mode: t
Recent input:
<right> SPC t o SPC C-M-` C-M-y <down> <return> <right>
. C-c C-c <S-up> C-x C-s C-x C-& <f5> a q <tab> <down>
<down> <down> <down> <down> <return> <down> <return>
<f11> a <down> <down> <down> <down> <return> g <down>
C-c I <down> <return> <f11> & <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> M f <up> M p <f11> & <f11> a <down>
<down> <down> <down> <return> g C M-p M-p M-p M-p M-p
M-p M-p <return> y <f11> a <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<return> b y <up> <up> u g L y C-x C-& C-x r l <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <return>
C-g C-x r l <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> C-o o C-g <S-up> C-x C-& t t q M-x s
e n d <tab> <backspace> <backspace> <backspace> <backspace>
<backspace> <backspace> <backspace> <backspace> <backspace>
<backspace> <backspace> <backspace> <backspace> <backspace>
C-g <f5> a p b b u u g g C-g M-x s u b m i <tab> <tab>
<backspace> <backspace> <backspace> <backspace> <backspace>
C-g <f5> a p b u u g g <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> <down> <down> <down> <down> <down> <down>
<down> <down> C-g M-x r e p o r t <tab> <down> <re
turn>
Recent messages:
Load: 1 file.
Region is from 67 to 327
Quit
Region is from 67 to 327 [2 times]
Quit
Computing completion candidates...
Computing completion candidates... [2 times]
Computing completion candidates...
--
A + Thierry Volpiatto
Location: Saint-Cyr-Sur-Mer - France
[-- Attachment #3: Type: message/rfc822, Size: 1609 bytes --]
From: Karl Fogel <kfogel@red-bean.com>
To: 4188-close@emacsbugs.donarmstrong.com
Subject: Fixed "doc strings in bookmark.el"
Date: Sun, 04 Oct 2009 21:36:31 -0400
Message-ID: <87y6nqmxk0.fsf@red-bean.com>
fixed
--
Thanks for the report. Fix committed:
$ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
/sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el
new revision: 1.128; previous revision: 1.127
/sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog
new revision: 1.16354; previous revision: 1.16353
Mailing notification to emacs-diffs@gnu.org... sent.
$
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4188: marked as done (23.1; doc strings in bookmark.el)
2009-10-05 1:45 ` bug#4188: marked as done (23.1; doc strings in bookmark.el) Emacs bug Tracking System
@ 2009-10-10 18:17 ` Drew Adams
2009-10-10 21:55 ` Karl Fogel
0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2009-10-10 18:17 UTC (permalink / raw)
To: 'Karl Fogel', bug-gnu-emacs
>> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings
>> altogether.
There are still some things that need doc strings.
`bookmark-current-buffer', for instance. The doc strings of other functions
(e.g. `bookmark-yank-word' need to refer to this buffer, but they cannot refer
to it by name, since `buffer-current-buffer' has no doc string.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4188: marked as done (23.1; doc strings in bookmark.el)
2009-10-10 18:17 ` Drew Adams
@ 2009-10-10 21:55 ` Karl Fogel
0 siblings, 0 replies; 6+ messages in thread
From: Karl Fogel @ 2009-10-10 21:55 UTC (permalink / raw)
To: Drew Adams; +Cc: bug-gnu-emacs
"Drew Adams" <drew.adams@oracle.com> writes:
>>> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings
>>> altogether.
>
> There are still some things that need doc strings.
>
> `bookmark-current-buffer', for instance. The doc strings of other
> functions (e.g. `bookmark-yank-word' need to refer to this buffer, but
> they cannot refer to it by name, since `buffer-current-buffer' has no
> doc string.
Oops, sorry, missed the variables. Fixed in these two revs:
$ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
/sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el
new revision: 1.135; previous revision: 1.134
/sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog
new revision: 1.16400; previous revision: 1.16399
Mailing notification to emacs-diffs@gnu.org... sent.
$ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
/sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el
new revision: 1.136; previous revision: 1.135
/sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog
new revision: 1.16401; previous revision: 1.16400
Mailing notification to emacs-diffs@gnu.org... sent.
$
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2009-10-10 21:55 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <87y6nqmxk0.fsf@red-bean.com>
2009-08-19 22:23 ` bug#4188: 23.1; doc strings in bookmark.el Drew Adams
2009-10-05 1:45 ` bug#4188: marked as done (23.1; doc strings in bookmark.el) Emacs bug Tracking System
2009-10-10 18:17 ` Drew Adams
2009-10-10 21:55 ` Karl Fogel
2009-08-31 7:45 ` bug#4296: 23.1; Change bookmark comments to docstring Thierry Volpiatto
2009-10-05 1:45 ` bug#4296: marked as done (23.1; Change bookmark comments to docstring.) Emacs bug Tracking System
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).