From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#64367: 28.2; doc string of `text-property-search-forward' Date: Sat, 01 Jul 2023 12:32:41 +0300 Message-ID: <83cz1cq8na.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1543"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 64367-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jul 01 11:33:35 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qFWz0-0000AN-Ka for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 01 Jul 2023 11:33:34 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qFWyV-0001i9-Gu; Sat, 01 Jul 2023 05:33:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qFWyU-0001hs-Dr for bug-gnu-emacs@gnu.org; Sat, 01 Jul 2023 05:33:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qFWyU-0002by-5Z for bug-gnu-emacs@gnu.org; Sat, 01 Jul 2023 05:33:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qFWyU-00076g-0x for bug-gnu-emacs@gnu.org; Sat, 01 Jul 2023 05:33:02 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sat, 01 Jul 2023 09:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 64367 X-GNU-PR-Package: emacs Mail-Followup-To: 64367@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 64367-done@debbugs.gnu.org id=D64367.168820393827263 (code D ref 64367); Sat, 01 Jul 2023 09:33:01 +0000 Original-Received: (at 64367-done) by debbugs.gnu.org; 1 Jul 2023 09:32:18 +0000 Original-Received: from localhost ([127.0.0.1]:56578 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qFWxm-00075f-Hk for submit@debbugs.gnu.org; Sat, 01 Jul 2023 05:32:18 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:52366) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qFWxk-00075R-K1 for 64367-done@debbugs.gnu.org; Sat, 01 Jul 2023 05:32:17 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qFWxe-0002Ya-Lz; Sat, 01 Jul 2023 05:32:10 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=vDrdXl1WraA/zeUeT+ErKb9j/K25y6rdBacGMck/+bQ=; b=n3hal3eTwv9D 1zS+1smRHt9H8FoGFiJIwAbrM0yZiKS+QJelm5G9bOHT204WVe11Z1HvSEu+yy7eo4LWJCfAjcw8X YjwjsV/QyWvROJTteVWlhzr2xa3pho1ugOq/sHmWTBlAYh/eOXp7QqL/J3J7abuKTNOYk2voRxDB3 tItP0RLIsh8csdqan7e7aIkp4gioZescHV5XL5FEzc0LXlwv/jbYxTgBRHd9eA3lAJAvD8HqgGqur dHoETldwlNzpdKo/IIajbmQTyU/KSnIoB9KCRh+etfU0emJIhcTIKk/uP2CFTmgD8VxuFN+GtFqan McQSu+fnvwW+LQaZujo4EA==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qFWxe-00028s-2P; Sat, 01 Jul 2023 05:32:10 -0400 In-Reply-To: (message from Drew Adams on Fri, 30 Jun 2023 15:07:02 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:264378 Archived-At: > From: Drew Adams > Date: Fri, 30 Jun 2023 15:07:02 +0000 > > The signature is this: > > (text-property-search-forward PROPERTY > &optional VALUE PREDICATE NOT-CURRENT) > > The arguments should be described in order. Only preferably so. It is not always possible to do so, and thus it is not a hard requirement. In this case, I see no way of describing the arguments in order and still producing a useful doc string, let alone its first line. > But the first line of the doc string - the most important - says this: > > Search for the next region of text where PREDICATE is true. > > Not only is PREDICATE optional; it is not even the first optional arg. > The first line should describe the _default_ behavior (nil VALUE, nil > PREDICATE). Now fixed on the emacs-29 branch. > Something like this: > > Search forward for text where PROPERTY is non-nil. This loses information and is also inaccurate, so I used a different text: Search for next region of text where PREDICATE returns non-nil for PROPERTY. Closing.