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#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols Date: Mon, 14 Nov 2022 15:05:33 +0200 Message-ID: <83leodk7oi.fsf@gnu.org> References: <875yfresq9.fsf@posteo.net> <831qq8ny2m.fsf@gnu.org> <87leog4018.fsf@posteo.net> <83o7tcm7ji.fsf@gnu.org> <83mt8wm5ai.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17354"; mail-complaints-to="usenet@ciao.gmane.io" Cc: thievol@posteo.net, joaotavora@gmail.com, 59082@debbugs.gnu.org To: rms@gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Nov 15 01:04:33 2022 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 1oujRJ-0004I2-7H for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 15 Nov 2022 01:04:33 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ouiog-0000ec-EN; Mon, 14 Nov 2022 18:24:39 -0500 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 1ouifT-0004K8-2G for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 18:15:09 -0500 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 1ouZA1-0004Qz-Tm for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 08:06:04 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ouZA1-0007sx-Lp for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 08:06:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 14 Nov 2022 13:06:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59082 X-GNU-PR-Package: emacs Original-Received: via spool by 59082-submit@debbugs.gnu.org id=B59082.166843113830279 (code B ref 59082); Mon, 14 Nov 2022 13:06:01 +0000 Original-Received: (at 59082) by debbugs.gnu.org; 14 Nov 2022 13:05:38 +0000 Original-Received: from localhost ([127.0.0.1]:49129 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ouZ9d-0007sJ-S3 for submit@debbugs.gnu.org; Mon, 14 Nov 2022 08:05:38 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:53298) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ouZ9c-0007s7-0e for 59082@debbugs.gnu.org; Mon, 14 Nov 2022 08:05:36 -0500 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 1ouZ9W-00044N-Ko; Mon, 14 Nov 2022 08:05:30 -0500 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=W+FeKhLdBF9/B/SX2iuvtDQPHymeA0UocYjQ6ogJFJw=; b=XdqKNSjJi/BB 0UGLCy0RLMFAIdyxk5GpU6J0JAlVyLqQpPDxZ6PaaR4bKY4897NxtPE+LGSYlvYj69c23xF1vvnM8 yzkutBGl5MBUTJWpKxmBH1zqH8UAI5pmgL6DnN73lYDNXCvFzVLAYP8E3B1Gvw6FUru7AW4Jk0PnD cEca7KGarqKrQQaezlRi6bFYGSAijWdoueA/LkzxOx5aI+PL5GCsWBueK8qwJ3vrHNG7YXLT8GOpY USbhuc8Cv6/DfOrpVezxZeshBOR8pZSnm2+DJhLu0prRoD4JCDVDyQY22KlWdhEgnOfRp60rcX2tF zNk/2mPLvQAcn7aS9fSF7A==; 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 1ouZ9O-00047q-NM; Mon, 14 Nov 2022 08:05:23 -0500 In-Reply-To: (message from Richard Stallman on Sun, 13 Nov 2022 22:13:00 -0500) 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:247845 Archived-At: > From: Richard Stallman > Cc: eliz@gnu.org, thievol@posteo.net, 59082@debbugs.gnu.org > Date: Sun, 13 Nov 2022 22:13:00 -0500 > > But if a doc string in s.el actually says "Calls the function > `s-foo'", nothing will translate that to `string-foo', So we will get > incorrect and confusing output. > > Does any doc string in s.el actually use the name of a function or > variable in s.el? It does. Here are a few examples: (defun s-split-up-to (separator s n &optional omit-nulls) "Split S up to N times into substrings bounded by matches for regexp SEPARATOR. If OMIT-NULLS is non-nil, zero-length substrings are omitted. See also `s-split'." (defun s-ends-with? (suffix s &optional ignore-case) "Does S end with SUFFIX? If IGNORE-CASE is non-nil, the comparison is done without paying attention to case differences. Alias: `s-suffix?'" (defun s-presence (s) "Return S if it's `s-present?', otherwise return nil." (defun s-count-matches-all (regexp s &optional start end) "Count occurrences of `regexp' in `s'. `start', inclusive, and `end', exclusive, delimit the part of `s' to match. `start' and `end' are both indexed starting at 1; the initial character in `s' is index 1. This function starts looking for the next match from the second character of the previous match. Hence, it counts matches that overlap a previously found match. To ignore matches that overlap a previously found match, use `s-count-matches'." I think it really is such a widespread (and good) practice to include cross-references in doc strings that it should be a no-brainer to decide that supporting this practice is important.