From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc fix. Date: Sat, 24 Jun 2023 18:32:00 +0300 Message-ID: References: <83cz1kzyyl.fsf@gnu.org> Reply-To: Eshel Yaron Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="10064"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 64266@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jun 24 17:33:19 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 1qD5GJ-0002MD-LK for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 24 Jun 2023 17:33:19 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qD5G3-0005IO-4Q; Sat, 24 Jun 2023 11: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 1qD5G2-0005ID-Dl for bug-gnu-emacs@gnu.org; Sat, 24 Jun 2023 11: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 1qD5G2-0006yX-5o for bug-gnu-emacs@gnu.org; Sat, 24 Jun 2023 11:33:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qD5G1-000068-Ky for bug-gnu-emacs@gnu.org; Sat, 24 Jun 2023 11:33:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eshel Yaron Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 24 Jun 2023 15:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 64266 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 64266-submit@debbugs.gnu.org id=B64266.1687620754338 (code B ref 64266); Sat, 24 Jun 2023 15:33:01 +0000 Original-Received: (at 64266) by debbugs.gnu.org; 24 Jun 2023 15:32:34 +0000 Original-Received: from localhost ([127.0.0.1]:41331 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qD5FZ-00005H-Qx for submit@debbugs.gnu.org; Sat, 24 Jun 2023 11:32:34 -0400 Original-Received: from mail.eshelyaron.com ([107.175.124.16]:54178 helo=eshelyaron.com) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qD5FY-000059-8r for 64266@debbugs.gnu.org; Sat, 24 Jun 2023 11:32:33 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=eshelyaron.com; s=mail; t=1687620751; bh=lwNwGNVtHq8b1AmVR+MA/ex4SyX+ef4pzsfwa3DOAgs=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=iVRqkCyVpXheuJhE5FdkHxYJ0Nmv2s81Enf8RCwyI9+Bc/m17LlNRpMTcuXHsVesL 6PyQZID7dNavDDoidBifBPOmiL6Mf1BQiDeUdX7NHAVnkLzp6WC4P+eXDEPF5cExLN R8MAobyO21lJzSa05Ph36nw9vo6bv3iILelZXg5qFG0kue6pe+PbfgkMdM7tRoWBTe nOxcalVZtFLnyBt85ETSNpA4jjuOBtThM0SSZJBg/BmHfounZel2PttIR+oVwSekg4 2WJ0Je7PE3ch0ANuU1tCMTGshZo0U+TWZdhuFktE+u8n4iASfec2uiBJ7YquampyU2 vqw4rsxOeXxrA== In-Reply-To: <83cz1kzyyl.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 24 Jun 2023 18:01:22 +0300") 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:264000 Archived-At: Eli Zaretskii writes: >> When no project is found in that directory, the result depends on >> the value of MAYBE-PROMPT: if it is nil or omitted, return nil, >> -else ask the user for a directory in which to look for the >> -project, and if no project is found there, return a \"transient\" >> -project instance. >> +else call the function specified by `project-prompter' to prompt >> +the user for a project's directory, and if no project is found >> +there, return a \"transient\" project instance. > > This starts by describing the implementation instead of describing the > behavior first. The doc string will be more useful if reworded like > this: > > When no project is found in that directory, the result depends on > the value of MAYBE-PROMPT: if it is nil or omitted, return nil, > else prompt the user for the project to use. > To prompt for a project, call the function specified by > `project-prompter', which returns the directory in which to > look for the project. If no project is found in that directory, > return a \"transient\" project instance. > > OK? Yes, that's clearer, thanks. Should I send an updated patch?