From: Eli Zaretskii <eliz@gnu.org>
To: rms@gnu.org
Cc: thievol@posteo.net, joaotavora@gmail.com, 59082@debbugs.gnu.org
Subject: bug#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols
Date: Mon, 14 Nov 2022 15:05:33 +0200 [thread overview]
Message-ID: <83leodk7oi.fsf@gnu.org> (raw)
In-Reply-To: <E1ouPu8-00027D-8s@fencepost.gnu.org> (message from Richard Stallman on Sun, 13 Nov 2022 22:13:00 -0500)
> From: Richard Stallman <rms@gnu.org>
> 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.
next prev parent reply other threads:[~2022-11-14 13:05 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-06 20:16 bug#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols Thierry Volpiatto
2022-11-12 12:42 ` Eli Zaretskii
2022-11-12 13:22 ` João Távora
2022-11-12 16:06 ` Thierry Volpiatto
2022-11-12 16:46 ` João Távora
2022-11-12 16:47 ` João Távora
2022-11-12 17:01 ` Eli Zaretskii
2022-11-12 17:18 ` João Távora
2022-11-12 17:49 ` Eli Zaretskii
2022-11-12 18:14 ` João Távora
2022-11-14 3:13 ` Richard Stallman
2022-11-14 6:39 ` João Távora
2022-11-14 13:11 ` Eli Zaretskii
2022-11-14 13:38 ` João Távora
2022-11-14 13:05 ` Eli Zaretskii [this message]
2022-11-14 13:36 ` João Távora
2022-11-14 13:56 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83leodk7oi.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=59082@debbugs.gnu.org \
--cc=joaotavora@gmail.com \
--cc=rms@gnu.org \
--cc=thievol@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).