Package: emacs;
Reported by: Emanuel Berg <moasenwood <at> zoho.eu>
Date: Fri, 5 Apr 2019 18:54:02 UTC
Severity: wishlist
Found in version 25.1
Done: Eli Zaretskii <eliz <at> gnu.org>
Bug is archived. No further changes may be made.
View this message in rfc822 format
From: help-debbugs <at> gnu.org (GNU bug Tracking System) To: Emanuel Berg <moasenwood <at> zoho.eu> Subject: bug#35163: closed (Re: bug#35163: 25.1; `narrow-to-region' docstring no mention of args) Date: Mon, 08 Apr 2019 16:56:02 +0000
[Message part 1 (text/plain, inline)]
Your bug report #35163: 25.1; `narrow-to-region' docstring no mention of args which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 35163 <at> debbugs.gnu.org. -- 35163: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=35163 GNU Bug Tracking System Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org> To: Glenn Morris <rgm <at> gnu.org> Cc: 35163-done <at> debbugs.gnu.org Subject: Re: bug#35163: 25.1; `narrow-to-region' docstring no mention of args Date: Mon, 08 Apr 2019 19:55:03 +0300> From: Glenn Morris <rgm <at> gnu.org> > Cc: 35163 <at> debbugs.gnu.org > Date: Mon, 08 Apr 2019 12:24:58 -0400 > > OP wants every doc string to literally contain the upper-case argument > names, ie START and END in this case (as per eg checkdoc's "Argument ... > should appear (as ...) in the doc string"). If you agree, it's a trivial > change. If not, close as wontfix. Thanks, fixed. > (People who have particular ideas about doc strings could save everyone > a lot of time by sending patches.) Or at least a clear description of the problem.
[Message part 3 (message/rfc822, inline)]
From: Emanuel Berg <moasenwood <at> zoho.eu> To: bug-gnu-emacs <at> gnu.org Subject: 25.1; `narrow-to-region' docstring no mention of args Date: Fri, 05 Apr 2019 20:51:37 +020025.1; `narrow-to-region' docstring no mention of args The `narrow-to-region' docstring does not mention its arguments as is the norm. And it makes sense, often the first thing I do when I bring up the help buffer for a function is to search for a particular argument name to see what it does. In GNU Emacs 25.1.1 (arm-unknown-linux-gnueabihf, GTK+ Version 3.22.11) of 2017-09-16, modified by Debian built on bm-wb-02 System Description: Raspbian GNU/Linux 9.8 (stretch) Configured using: 'configure --build arm-linux-gnueabihf --prefix=/usr --sharedstatedir=/var/lib --libexecdir=/usr/lib --localstatedir=/var/lib --infodir=/usr/share/info --mandir=/usr/share/man --with-pop=yes --enable-locallisppath=/etc/emacs25:/etc/emacs:/usr/local/share/emacs/25.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/25.1/site-lisp:/usr/share/emacs/site-lisp --with-sound=alsa --build arm-linux-gnueabihf --prefix=/usr --sharedstatedir=/var/lib --libexecdir=/usr/lib --localstatedir=/var/lib --infodir=/usr/share/info --mandir=/usr/share/man --with-pop=yes --enable-locallisppath=/etc/emacs25:/etc/emacs:/usr/local/share/emacs/25.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/25.1/site-lisp:/usr/share/emacs/site-lisp --with-sound=alsa --with-x=yes --with-x-toolkit=gtk3 --with-toolkit-scroll-bars 'CFLAGS=-g -O2 -fdebug-prefix-map=/build/emacs25-pkwV6G/emacs25-25.1+1=. -fstack-protector-strong -Wformat -Werror=format-security -Wall' 'CPPFLAGS=-Wdate-time -D_FORTIFY_SOURCE=2' LDFLAGS=-Wl,-z,relro' Configured features: XPM JPEG TIFF GIF PNG RSVG IMAGEMAGICK SOUND GPM DBUS GCONF GSETTINGS NOTIFY ACL LIBSELINUX GNUTLS LIBXML2 FREETYPE M17N_FLT LIBOTF XFT ZLIB TOOLKIT_SCROLL_BARS GTK3 X11 Important settings: value of $LANG: en_GB.UTF-8 locale-coding-system: utf-8-unix Major mode: Fundamental Minor modes in effect: show-paren-mode: t shell-dirtrack-mode: t erc-list-mode: t erc-menu-mode: t erc-autojoin-mode: t erc-ring-mode: t erc-networks-mode: t erc-pcomplete-mode: t erc-match-mode: t erc-button-mode: t erc-fill-mode: t erc-stamp-mode: t erc-netsplit-mode: t erc-irccontrols-mode: t erc-noncommands-mode: t erc-move-to-prompt-mode: t erc-readonly-mode: t erc-scrolltobottom-mode: t global-eldoc-mode: t electric-indent-mode: t mouse-wheel-mode: t tool-bar-mode: t global-font-lock-mode: t font-lock-mode: t auto-composition-mode: t auto-compression-mode: t transient-mark-mode: t Recent messages: scroll-up-1: Beginning of buffer [6 times] ... o-) Saving file /home/incal/DO_THIS... Wrote /home/incal/DO_THIS Type "q" to restore previous buffer. hit: 123 This is the one occurrence. [2 times] Quit [2 times] Mark set Load-path shadows: /usr/share/emacs/25.1/site-lisp/debian-startup hides /usr/share/emacs/site-lisp/debian-startup /usr/share/emacs25/site-lisp/flim/md4 hides /usr/share/emacs/25.1/lisp/md4 /usr/share/emacs25/site-lisp/flim/hex-util hides /usr/share/emacs/25.1/lisp/hex-util ~/.emacs.d/lisp/abbrev hides /usr/share/emacs/25.1/lisp/abbrev ~/.emacs.d/emacs-init/gnus/server hides /usr/share/emacs/25.1/lisp/server /usr/share/emacs25/site-lisp/flim/sasl-ntlm hides /usr/share/emacs/25.1/lisp/net/sasl-ntlm /usr/share/emacs25/site-lisp/flim/sasl-cram hides /usr/share/emacs/25.1/lisp/net/sasl-cram /usr/share/emacs25/site-lisp/flim/ntlm hides /usr/share/emacs/25.1/lisp/net/ntlm /usr/share/emacs25/site-lisp/flim/sasl hides /usr/share/emacs/25.1/lisp/net/sasl /usr/share/emacs25/site-lisp/flim/hmac-def hides /usr/share/emacs/25.1/lisp/net/hmac-def /usr/share/emacs25/site-lisp/flim/hmac-md5 hides /usr/share/emacs/25.1/lisp/net/hmac-md5 /usr/share/emacs25/site-lisp/flim/sasl-digest hides /usr/share/emacs/25.1/lisp/net/sasl-digest /home/incal/.emacs.d/elpa/seq-2.20/seq hides /usr/share/emacs/25.1/lisp/emacs-lisp/seq /home/incal/.emacs.d/elpa/let-alist-1.0.5/let-alist hides /usr/share/emacs/25.1/lisp/emacs-lisp/let-alist Features: (shadow emacsbug conf-mode mm-archive sh-script smie executable mailalias w3m-cookie canlock url-http url-gw url-cache url-auth mail-extr qp gnus-async gnus-bcklg gnus-ml make-mode eieio-opt speedbar sb-image ezimage dframe find-func whitespace cus-edit cus-start cus-load tabify nnir cursor-sensor pop3 nndraft nnmh nnml network-stream nsm starttls gnus-agent nnvirtual nntp gnus-cache w3m-filter ffap paren xsel w3m-form google-translate-core-ui ido google-translate-core google-translate-tk url url-proxy url-privacy url-expand url-methods url-history url-cookie url-domsuf url-util url-parse url-vars json map lpr tramp-sh term disp-table ehelp my-faces t-mouse man tex-mode iterate-files seq-24 isbn my-bibtex bibtex slime-presentations slime-repl slime-parse bridge nroff-mode sgml-mode cobol-mode ada-mode which-func imenu align find-file checkdoc cc-mode cc-fonts cc-guess cc-menus cc-cmds cc-styles cc-align cc-engine cc-vars cc-defs guile summary message-my moggle mail-to-many mail smtpmail sendmail font-lock-add global-keys yank-my wrap-search w3m-unisearch w3m-search spell-new ispell sort-my sort slime etags xref project arc-mode archive-mode noutline outline easy-mmode hyperspec shell-cli revert-buffer-my lisp-new ielm kill keys help-new debug apropos dired-x compile-my mode-line compile article gnus-cite dl bookmarks w3m-bookmark file-write-to erc-my fill-new quit gnus-my group group-summary gnus-srvr gnus-score score-mode gnus-msg gnus-art mm-uu mml2015 mm-view mml-smime smime dig mailcap gnus-sum gnus-group gnus-undo gnus-start gnus-cloud nnimap nnmail mail-source tls gnutls utf7 netrc nnoo parse-time gnus-spec gnus-int gnus-range gnus-win message rfc822 mml mml-sec epg mm-decode mm-bodies mm-encode mail-parse rfc2231 rfc2047 rfc2045 ietf-drums mailabbrev gmm-utils mailheader gnus gnus-ems nnheader mail-utils edit tabs dired-my w3m-my w3m-tabs w3m-session w3m browse-url doc-view jka-compr image-mode timezone w3m-hist w3m-fb bookmark-w3m w3m-ems w3m-ccl ccl w3m-favicon w3m-image w3m-proc w3m-util time-my linux-shell files-my tramp tramp-compat tramp-loaddefs trampver ucs-normalize shell advice sudo-user-path find-command window-new count get-search-string caps-back buffer-menu switch-to-buffer super scroll dired close buc switch-to-buffer-regexp subr-x align-new erc-list erc-menu erc-join erc-ring erc-networks erc-pcomplete pcomplete comint ansi-color ring erc-track erc-match erc-button wid-edit erc-fill erc-stamp erc-netsplit erc-goodies erc erc-backend erc-compat format-spec auth-source cl-seq eieio eieio-core cl-macs gnus-util time-date mm-util help-fns mail-prsvr password-cache thingatpt pp my-string search-regexp-in-files finder-inf info slime-autoloads package epg-config seq byte-opt gv bytecomp byte-compile cl-extra help-mode easymenu cconv cl-loaddefs pcase cl-lib w3m-load mule-util tooltip eldoc electric uniquify ediff-hook vc-hooks lisp-float-type mwheel x-win term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe tabulated-list newcomment elisp-mode lisp-mode prog-mode register page menu-bar rfn-eshadow timer select scroll-bar mouse jit-lock font-lock syntax facemenu font-core frame cl-generic cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european ethiopic indian cyrillic chinese charscript case-table epa-hook jka-cmpr-hook help simple abbrev minibuffer cl-preloaded nadvice loaddefs button faces cus-face macroexp files text-properties overlay sha1 md5 base64 format env code-pages mule custom widget hashtable-print-readable backquote dbusbind inotify dynamic-setting system-font-setting font-render-setting move-toolbar gtk x-toolkit x multi-tty make-network-process emacs) Memory information: ((conses 8 562500 116792) (symbols 24 49692 133) (miscs 20 414 2943) (strings 16 124316 18946) (string-bytes 1 3748017) (vectors 8 73884) (vector-slots 4 1902625 44262) (floats 8 605 859) (intervals 28 10539 2722) (buffers 520 96)) -- underground experts united http://user.it.uu.se/~embe8573
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.