* bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG @ 2013-12-10 18:44 Drew Adams 2013-12-10 21:59 ` Drew Adams 2014-02-08 3:00 ` Lars Ingebrigtsen 0 siblings, 2 replies; 3+ messages in thread From: Drew Adams @ 2013-12-10 18:44 UTC (permalink / raw) To: 16102 Describe parameter REGEXP-FLAG. Doc strings should describe the functions parameters. (Code should not be committed without a check for this.) In GNU Emacs 24.3.50.2 (i686-pc-mingw32) of 2013-11-28 on LEG570 Bzr revision: 115271 rgm@gnu.org-20131128203155-qjc1xsp19z2k64b2 Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1' ^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG 2013-12-10 18:44 bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG Drew Adams @ 2013-12-10 21:59 ` Drew Adams 2014-02-08 3:00 ` Lars Ingebrigtsen 1 sibling, 0 replies; 3+ messages in thread From: Drew Adams @ 2013-12-10 21:59 UTC (permalink / raw) To: 16102 Similarly, for the other doc strings that are missing a description of parameter REGEXP-FLAG. It is fine to refer to another doc string for the description (that only requires a click by the user). It is not fine for the doc string to say nothing about the parameter. ^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG 2013-12-10 18:44 bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG Drew Adams 2013-12-10 21:59 ` Drew Adams @ 2014-02-08 3:00 ` Lars Ingebrigtsen 1 sibling, 0 replies; 3+ messages in thread From: Lars Ingebrigtsen @ 2014-02-08 3:00 UTC (permalink / raw) To: Drew Adams; +Cc: 16102 Drew Adams <drew.adams@oracle.com> writes: > Describe parameter REGEXP-FLAG. Doc strings should describe the > functions parameters. (Code should not be committed without a check for > this.) If it's obvious what the parameters do, wittering on about them in the doc strings serve no purpose. These are all pretty internalish functions. If you don't get that the meaning of REGEXP-FLAG in all these functions means that we're doing regexp searches instead of non-regexp searches, you're probably doing something wrong. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-02-08 3:00 UTC | newest] Thread overview: 3+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2013-12-10 18:44 bug#16102: 24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG Drew Adams 2013-12-10 21:59 ` Drew Adams 2014-02-08 3:00 ` Lars Ingebrigtsen
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).