From unknown Thu Jun 19 14:17:01 2025 X-Loop: help-debbugs@gnu.org Subject: bug#76797: 29.1; read-string docstring doesn't mention return value Resent-From: Howard Melman Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 07 Mar 2025 02:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 76797 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 76797@debbugs.gnu.org X-Debbugs-Original-To: GNU Emacs Received: via spool by submit@debbugs.gnu.org id=B.174131510229287 (code B ref -1); Fri, 07 Mar 2025 02:39:02 +0000 Received: (at submit) by debbugs.gnu.org; 7 Mar 2025 02:38:22 +0000 Received: from localhost ([127.0.0.1]:46149 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tqNbS-0007cI-3B for submit@debbugs.gnu.org; Thu, 06 Mar 2025 21:38:22 -0500 Received: from lists.gnu.org ([2001:470:142::17]:59970) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tqNbO-0007bz-HV for submit@debbugs.gnu.org; Thu, 06 Mar 2025 21:38:19 -0500 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 1tqNbI-0006rr-Cy for bug-gnu-emacs@gnu.org; Thu, 06 Mar 2025 21:38:12 -0500 Received: from mail-qk1-x733.google.com ([2607:f8b0:4864:20::733]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tqNbG-0005kU-LH for bug-gnu-emacs@gnu.org; Thu, 06 Mar 2025 21:38:12 -0500 Received: by mail-qk1-x733.google.com with SMTP id af79cd13be357-7c3b63dfebfso150111985a.3 for ; Thu, 06 Mar 2025 18:38:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1741315088; x=1741919888; darn=gnu.org; h=to:date:message-id:subject:mime-version:content-transfer-encoding :from:from:to:cc:subject:date:message-id:reply-to; bh=eobdo/JeC8mI/N3GU/jRKaAMJe199/jVzhLcju79kVQ=; b=EGspY4F1JACZXdlFLQZolwWH1/MpxP1L9jrpZBdLdgH12OxdNbz2mhNjM1j34zjksF CIzpzN2jckvu37ou+wC+DiMsxC4+UERaHC00ALxCdgIs3W78kvveN3gT1B/lry3k2Ye8 vAZwHmCzyUkO8xO8At5BRp3v1sLNTeY2Klo9Tmt2R/HOpf4XCYe2FPVd+lp1aKj5abeg UCvxEG8wYv2ULDx+HFCmmK/wBR7JiFRSZxzfZ/RktlGobiruby8P31mEawipqi5Hwb9s H9ew1H8WamgafCQQtn1wu38LrW7n0TyLa7zGZAzSyiHfIGCb7hvyVRBquPxmR7yQhu4/ C9XA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741315088; x=1741919888; h=to:date:message-id:subject:mime-version:content-transfer-encoding :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=eobdo/JeC8mI/N3GU/jRKaAMJe199/jVzhLcju79kVQ=; b=UD/zxY5Edj02ARzV1R+FMWUSNo8qKAFWmd26nsLMCSYy9umfC/5+SbiQ0UeVoZEiwB 8zev7S3fqztNRBTotnvUWv5hZqbgdIlWy81j7yFVmLOOyZFNd3QWVbwYGNYasokG4O+b QogxkVNexGuKB/h9rvTZdAvO7QvOqTirBA9DPL/aH2pvCaMaBgmmgIb540aJiqfc5ett 1a8N+myeKNKVtfmK2mruou21QAKrKAy6QP9AdBcKPwdR8Yv46NzOTmilS+cH01LRC2EB eUdl3+wX66IJsewOYLoyopQhz4o5apyN+OKym84MZD1Fq5amH4cU+HpPGqIAk6xnln+m 52/A== X-Gm-Message-State: AOJu0YwusVqLMbPVWbUkmPTq5Ou1voTeRngIMlGogZLwh6GYGstbcmQh xRLIArOQUwhpoxVa1oyR3TFa8nwzTtu8CEy4r8BBHgKVz8GUlbSMPxGxFqEl X-Gm-Gg: ASbGncs1/82+OC2PVJhFLZzICrlojlXBnznKxRKXf7edqlzZ8R84iILNtFmVQERur1r 9egU31Wdbp0GQGjSeRQtn2VOsyFgPSdo7XiC3wZ8sC+YcOmnveaZ2+HbTAy11Oe1YJTIus3ATLu oyTU9UpqpJGT8aKJ3jqL/oii7yjbkrzKJ6eoLEj23GV2d8Ok3AgOqo5maPJY722KvJf+1uvJ6YP 4h4+ATCMezvJn/X2vJEHOLYgwmNYvWU7c+akqYXfKasTWIwDlYcg1x97JVcVk5f7D9LUPMRPWMt rSKE0H1DAsHTWmN3R9kMzMo3INbJGBW0Tk52S8VTxqrrviqi+SmmE2VScF245Q== X-Google-Smtp-Source: AGHT+IFBhXT2ReWMZ52B0AlGoR9Z7w/P7XQuhi1TK33PXiJOArce/maOm5XuZn50n+xFyl4OlzgeLA== X-Received: by 2002:a05:620a:270a:b0:7c3:beed:d46a with SMTP id af79cd13be357-7c4e6178e58mr211321185a.38.1741315087713; Thu, 06 Mar 2025 18:38:07 -0800 (PST) Received: from smtpclient.apple ([72.85.185.24]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7c3e534c76fsm174269285a.41.2025.03.06.18.38.05 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 06 Mar 2025 18:38:06 -0800 (PST) From: Howard Melman Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.700.6.1.9\)) Message-Id: <2C7DA520-CDE6-4A09-AFAD-078933C2C950@gmail.com> Date: Thu, 6 Mar 2025 21:37:55 -0500 X-Mailer: Apple Mail (2.3731.700.6.1.9) Received-SPF: pass client-ip=2607:f8b0:4864:20::733; envelope-from=hmelman@gmail.com; helo=mail-qk1-x733.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) The docstring for read-string in emacs 29.1 doesn't mention its return value (though the 4th arg describes what it returns if the user enters the empty string). I agree it's kind of obvious that it returns the read string but not seeing it explicitly made me scan for something I might have been missing. I suggest the first line instead of: Read a string from the minibuffer, prompting with string PROMPT. be: Return a string read from the minibuffer, prompting with string PROMPT. or if 71 characters is too long, one of: Return a string read from the minibuffer, prompting with PROMPT. Return a string read from the minibuffer, using PROMPT string. Return a string read from the minibuffer, using string PROMPT. Or just mention the return value in the one of the other lines. -- Howard From unknown Thu Jun 19 14:17:01 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Howard Melman Subject: bug#76797: closed (Re: bug#76797: 29.1; read-string docstring doesn't mention return value) Message-ID: References: <2C7DA520-CDE6-4A09-AFAD-078933C2C950@gmail.com> X-Gnu-PR-Message: they-closed 76797 X-Gnu-PR-Package: emacs Reply-To: 76797@debbugs.gnu.org Date: Fri, 07 Mar 2025 17:16:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1741367762-10428-1" This is a multi-part message in MIME format... ------------=_1741367762-10428-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #76797: 29.1; read-string docstring doesn't mention return value 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 76797@debbugs.gnu.org. --=20 76797: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D76797 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1741367762-10428-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 76797-done) by debbugs.gnu.org; 7 Mar 2025 17:15:11 +0000 Received: from localhost ([127.0.0.1]:49861 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tqbHz-0002bp-Ho for submit@debbugs.gnu.org; Fri, 07 Mar 2025 12:15:11 -0500 Received: from mail-ed1-x531.google.com ([2a00:1450:4864:20::531]:46099) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1tqbHv-0002aa-EH for 76797-done@debbugs.gnu.org; Fri, 07 Mar 2025 12:15:08 -0500 Received: by mail-ed1-x531.google.com with SMTP id 4fb4d7f45d1cf-5e5e7fd051bso1140430a12.0 for <76797-done@debbugs.gnu.org>; Fri, 07 Mar 2025 09:15:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1741367701; x=1741972501; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=fXfVNsgcESBx0uFm2HWSGAyfQJXwFKyxCLBMdWynWxM=; b=DPMvfsMeRdUrArYL1Wp/yNseivhJ19RN7MlQ3iDhGu+z/MoXYhm81nKnjeSsnjSQjc P/F/Gy1NAf8Vtza3UbHI4aquf2Vd9p0QK8033TdaSCN60t2erbtLb31MOtasKwS/545I ctzOWGR0hA3h3tS7v+TL7VEL//8x0bnfvz5AktK117mU+VtHJXH67HqukqYWfofee2Lp x3uTGflxqXOTGg5IKgconC1HHFrXIjoltHpOYu2TbTLJulXlAIcd/DMlYGTlrKIjWODA C6hXxfGphEzT7FVAaHwdM6tRWEVr5gSYlSgF/YHPUsBbq3NeVxZU5qRHasrOUnqjW2ne TEuw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741367701; x=1741972501; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=fXfVNsgcESBx0uFm2HWSGAyfQJXwFKyxCLBMdWynWxM=; b=jqsQlSFYBT8gxTRWPAdhB4PL4qZqYma/R+GxFQ472mL8WwChpPwoj8ejbR/1YWdfrF T9VXWFHHh3yp9oxLRTdL5dRMs2gbxvPrgG0ZWOoMqtl/Z3PaKHQP07hthFist1+9NwEV itsrbRbymuX9F7pMY7rVwRpwJjkYWScw4KY6w16Avz00OcFUl3pqKXAhh5mDA8sP728X ycpTPPmWqXZbLQ0gM22+Ppoo9xAzyzece0uH+aqvmjBQqSZO3bVauuxEOi9gUUEcsb1n nCbWkpa+Y0m8mjLXwOx2MVP14Yt0Oa3dE5OOlnDyA6L81+StlEDjvmeHzTFELc8NJ+OY H5vQ== X-Forwarded-Encrypted: i=1; AJvYcCVV4temB0VNLpNagCTayEIodZ3tmi4NvKe+FZhjT+38qwNR2qGdzIMSnbyK0eOimZs6Iv8Ocs7B7w/i@debbugs.gnu.org X-Gm-Message-State: AOJu0Yzp1CqMke6ru1h5MwiJl4tMkl7d0CjbTrajCZfg240lMUJ9DN4L Ja5tXD9vadFoBTPHjzB8V27uJizMBnvqKnsyIt35akd7HEgJ0QqBjYCw3F8QqWeepD7sN5DMOQD pCRRwiKyJv5U67YebspkApu4AgSQ= X-Gm-Gg: ASbGnctciRsr/MB6MxHVVO/G6v+aX3vhtjBsvEPXsBPTJnQwgQV5Vqcs4MMLsJ9VA7N 9zgW+vM1Rw2PZpef3CLUnjW3bjOoJIMR+E9K1oHIkwk3+KqzlJAQ/YKoY0xze9yB6DuLrGet6w/ 08TZUPObr7z71zHYn5+T2bZfjuVA== X-Google-Smtp-Source: AGHT+IEblq2FwDTAEUk3rk0IeOwGTBbhcTFzNRLg/FnoiuxQX7ogXZ5Lwoa8KD8IUky1syEWzroRHO3reSkBPk3asEg= X-Received: by 2002:a05:6402:518a:b0:5e4:a88a:657 with SMTP id 4fb4d7f45d1cf-5e5e24f833amr5275934a12.28.1741367700499; Fri, 07 Mar 2025 09:15:00 -0800 (PST) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Fri, 7 Mar 2025 17:15:00 +0000 From: Stefan Kangas In-Reply-To: <2C7DA520-CDE6-4A09-AFAD-078933C2C950@gmail.com> References: <2C7DA520-CDE6-4A09-AFAD-078933C2C950@gmail.com> MIME-Version: 1.0 Date: Fri, 7 Mar 2025 17:15:00 +0000 X-Gm-Features: AQ5f1JpaMiL53yUeD1lfXWxOCGHXG9nMO56ofYaLlZTN-sqGj5bfg6tFKvxvmHE Message-ID: Subject: Re: bug#76797: 29.1; read-string docstring doesn't mention return value To: Howard Melman , 76797-done@debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 76797-done X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Version: 30.2 Howard Melman writes: > The docstring for read-string in emacs 29.1 doesn't mention > its return value (though the 4th arg describes what it > returns if the user enters the empty string). > > I agree it's kind of obvious that it returns the read string > but not seeing it explicitly made me scan for something I > might have been missing. > > I suggest the first line instead of: > > Read a string from the minibuffer, prompting with string PROMPT. > > be: > > Return a string read from the minibuffer, prompting with string PROMPT. > > or if 71 characters is too long, one of: > > Return a string read from the minibuffer, prompting with PROMPT. > Return a string read from the minibuffer, using PROMPT string. > Return a string read from the minibuffer, using string PROMPT. > > Or just mention the return value in the one of the other lines. Thanks, fixed on emacs-30. Closing. ------------=_1741367762-10428-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 7 Mar 2025 02:38:22 +0000 Received: from localhost ([127.0.0.1]:46149 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tqNbS-0007cI-3B for submit@debbugs.gnu.org; Thu, 06 Mar 2025 21:38:22 -0500 Received: from lists.gnu.org ([2001:470:142::17]:59970) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tqNbO-0007bz-HV for submit@debbugs.gnu.org; Thu, 06 Mar 2025 21:38:19 -0500 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 1tqNbI-0006rr-Cy for bug-gnu-emacs@gnu.org; Thu, 06 Mar 2025 21:38:12 -0500 Received: from mail-qk1-x733.google.com ([2607:f8b0:4864:20::733]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tqNbG-0005kU-LH for bug-gnu-emacs@gnu.org; Thu, 06 Mar 2025 21:38:12 -0500 Received: by mail-qk1-x733.google.com with SMTP id af79cd13be357-7c3b63dfebfso150111985a.3 for ; Thu, 06 Mar 2025 18:38:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1741315088; x=1741919888; darn=gnu.org; h=to:date:message-id:subject:mime-version:content-transfer-encoding :from:from:to:cc:subject:date:message-id:reply-to; bh=eobdo/JeC8mI/N3GU/jRKaAMJe199/jVzhLcju79kVQ=; b=EGspY4F1JACZXdlFLQZolwWH1/MpxP1L9jrpZBdLdgH12OxdNbz2mhNjM1j34zjksF CIzpzN2jckvu37ou+wC+DiMsxC4+UERaHC00ALxCdgIs3W78kvveN3gT1B/lry3k2Ye8 vAZwHmCzyUkO8xO8At5BRp3v1sLNTeY2Klo9Tmt2R/HOpf4XCYe2FPVd+lp1aKj5abeg UCvxEG8wYv2ULDx+HFCmmK/wBR7JiFRSZxzfZ/RktlGobiruby8P31mEawipqi5Hwb9s H9ew1H8WamgafCQQtn1wu38LrW7n0TyLa7zGZAzSyiHfIGCb7hvyVRBquPxmR7yQhu4/ C9XA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741315088; x=1741919888; h=to:date:message-id:subject:mime-version:content-transfer-encoding :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=eobdo/JeC8mI/N3GU/jRKaAMJe199/jVzhLcju79kVQ=; b=UD/zxY5Edj02ARzV1R+FMWUSNo8qKAFWmd26nsLMCSYy9umfC/5+SbiQ0UeVoZEiwB 8zev7S3fqztNRBTotnvUWv5hZqbgdIlWy81j7yFVmLOOyZFNd3QWVbwYGNYasokG4O+b QogxkVNexGuKB/h9rvTZdAvO7QvOqTirBA9DPL/aH2pvCaMaBgmmgIb540aJiqfc5ett 1a8N+myeKNKVtfmK2mruou21QAKrKAy6QP9AdBcKPwdR8Yv46NzOTmilS+cH01LRC2EB eUdl3+wX66IJsewOYLoyopQhz4o5apyN+OKym84MZD1Fq5amH4cU+HpPGqIAk6xnln+m 52/A== X-Gm-Message-State: AOJu0YwusVqLMbPVWbUkmPTq5Ou1voTeRngIMlGogZLwh6GYGstbcmQh xRLIArOQUwhpoxVa1oyR3TFa8nwzTtu8CEy4r8BBHgKVz8GUlbSMPxGxFqEl X-Gm-Gg: ASbGncs1/82+OC2PVJhFLZzICrlojlXBnznKxRKXf7edqlzZ8R84iILNtFmVQERur1r 9egU31Wdbp0GQGjSeRQtn2VOsyFgPSdo7XiC3wZ8sC+YcOmnveaZ2+HbTAy11Oe1YJTIus3ATLu oyTU9UpqpJGT8aKJ3jqL/oii7yjbkrzKJ6eoLEj23GV2d8Ok3AgOqo5maPJY722KvJf+1uvJ6YP 4h4+ATCMezvJn/X2vJEHOLYgwmNYvWU7c+akqYXfKasTWIwDlYcg1x97JVcVk5f7D9LUPMRPWMt rSKE0H1DAsHTWmN3R9kMzMo3INbJGBW0Tk52S8VTxqrrviqi+SmmE2VScF245Q== X-Google-Smtp-Source: AGHT+IFBhXT2ReWMZ52B0AlGoR9Z7w/P7XQuhi1TK33PXiJOArce/maOm5XuZn50n+xFyl4OlzgeLA== X-Received: by 2002:a05:620a:270a:b0:7c3:beed:d46a with SMTP id af79cd13be357-7c4e6178e58mr211321185a.38.1741315087713; Thu, 06 Mar 2025 18:38:07 -0800 (PST) Received: from smtpclient.apple ([72.85.185.24]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7c3e534c76fsm174269285a.41.2025.03.06.18.38.05 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 06 Mar 2025 18:38:06 -0800 (PST) From: Howard Melman Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.700.6.1.9\)) Subject: 29.1; read-string docstring doesn't mention return value Message-Id: <2C7DA520-CDE6-4A09-AFAD-078933C2C950@gmail.com> Date: Thu, 6 Mar 2025 21:37:55 -0500 To: GNU Emacs X-Mailer: Apple Mail (2.3731.700.6.1.9) Received-SPF: pass client-ip=2607:f8b0:4864:20::733; envelope-from=hmelman@gmail.com; helo=mail-qk1-x733.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) The docstring for read-string in emacs 29.1 doesn't mention its return value (though the 4th arg describes what it returns if the user enters the empty string). I agree it's kind of obvious that it returns the read string but not seeing it explicitly made me scan for something I might have been missing. I suggest the first line instead of: Read a string from the minibuffer, prompting with string PROMPT. be: Return a string read from the minibuffer, prompting with string PROMPT. or if 71 characters is too long, one of: Return a string read from the minibuffer, prompting with PROMPT. Return a string read from the minibuffer, using PROMPT string. Return a string read from the minibuffer, using string PROMPT. Or just mention the return value in the one of the other lines. -- Howard ------------=_1741367762-10428-1--