From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Julian Scheid Newsgroups: gmane.emacs.bugs Subject: bug#46662: [PATCH] cl-extra: Fix docstring retrieval Date: Sun, 21 Feb 2021 00:42:20 +1300 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="0000000000006cb2ed05bbc31092" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2347"; mail-complaints-to="usenet@ciao.gmane.io" To: 46662@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Feb 20 12:43:48 2021 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 1lDQfr-0000WS-Mg for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 20 Feb 2021 12:43:47 +0100 Original-Received: from localhost ([::1]:41692 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lDQfq-0008Fq-P0 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 20 Feb 2021 06:43:46 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50246) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lDQf8-0007zS-Lk for bug-gnu-emacs@gnu.org; Sat, 20 Feb 2021 06:43:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:39592) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lDQf8-0004nV-Do for bug-gnu-emacs@gnu.org; Sat, 20 Feb 2021 06:43:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lDQf8-0002qx-BC for bug-gnu-emacs@gnu.org; Sat, 20 Feb 2021 06:43:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Julian Scheid Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 20 Feb 2021 11:43:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 46662 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.161382136210934 (code B ref -1); Sat, 20 Feb 2021 11:43:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 20 Feb 2021 11:42:42 +0000 Original-Received: from localhost ([127.0.0.1]:51136 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lDQeo-0002qH-DS for submit@debbugs.gnu.org; Sat, 20 Feb 2021 06:42:42 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:42736) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lDQei-0002q6-U1 for submit@debbugs.gnu.org; Sat, 20 Feb 2021 06:42:40 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50212) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lDQei-0007xP-M5 for bug-gnu-emacs@gnu.org; Sat, 20 Feb 2021 06:42:36 -0500 Original-Received: from mail-pj1-x1030.google.com ([2607:f8b0:4864:20::1030]:55201) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lDQeg-0004c7-3F for bug-gnu-emacs@gnu.org; Sat, 20 Feb 2021 06:42:36 -0500 Original-Received: by mail-pj1-x1030.google.com with SMTP id cx11so3152940pjb.4 for ; Sat, 20 Feb 2021 03:42:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=042RW3y9VWfqTBPkme1hLlbBXZ9E6qeWp2AkiwspVlI=; b=PVxIdB+2EvAuoGwg5X+giUUVl3t5HIZMr7USqHYGoUeT+21IpVXKMfd6CL/qDLJZ0S IK2aJ1wQnMtjgbN1AocA9kutXN0N1hQ5VtbJ8oa7cu6pQc27ej1l2EIQdnWOM+quPMUW uUJ+q27nVyMb1YXc9HUzZrkAgYcoW0uki3bU1JHROberFJDrTGq+8L6IAU1OsllYVIxW l1SRNT8GrrXjGvOsOzhMWFeV7K2U+/RmbCnQntef6DoQQRuJILvw/zagQ5YYM/sQrUHe XEFhHh4eKCCdjuHVZ1cV7e5OSGVC3pLmitF8y9/vuf2jL4pq7br6iPXj9eIpp4YPQHm4 xATQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=042RW3y9VWfqTBPkme1hLlbBXZ9E6qeWp2AkiwspVlI=; b=h1KLN65yf7cOxchUf8/+74w4zaHg+qAJGsJWAK8azsajOhwVIjxlq9j3sXrL/AVKZu Hz8g0GHnszvYA2e6xvhwH5xCJUjgZfuUg5F+Jxk/R0OG/DQJrS5BvCxbXe9Vz9R0W39C ClnxsMUJWYC8Sa+SVuq7PDSq4vojtjiEDhQzDFzvL9a9XZTMnDvs4SiebWZWsV+x7oNx S34QifbvES9qzF1MU0mE8V8BCkwKrbzr7UYAE+TO5LuK5ZneGnM9B1RYc6oNX4eq4Hvo G3XB9cBo+o5RUdT39OrNA3I26jTI/ciBw6P4+Ejoyp2x8c2PrtXv8lnDROBLr6vsG0Dk n6KA== X-Gm-Message-State: AOAM531LYzhXMjtak7DIn19aUk13dZxMi/5+mWA1UxgX+ZFgG2bbM6vV fj69rTR7FE2gwv3h5fDj/u/ftYcDnPAuqszW3sODTZLIk2iSAw== X-Google-Smtp-Source: ABdhPJyne7PPCoDavchngY5+VmplIxerl+gEeSKquv9eU/Sedw3dW4mcCHdaO5r3b1undJIq/ZaKhIHPG+jyTNGw33o= X-Received: by 2002:a17:90a:9909:: with SMTP id b9mr13083279pjp.46.1613821352085; Sat, 20 Feb 2021 03:42:32 -0800 (PST) Received-SPF: pass client-ip=2607:f8b0:4864:20::1030; envelope-from=julians37@gmail.com; helo=mail-pj1-x1030.google.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 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_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, HTML_MESSAGE=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-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" Xref: news.gmane.io gmane.emacs.bugs:200416 Archived-At: --0000000000006cb2ed05bbc31092 Content-Type: multipart/alternative; boundary="0000000000006cb2eb05bbc31090" --0000000000006cb2eb05bbc31090 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Given (require 'cl-macs) (cl-defstruct foobar (baz nil :documentation "an important piece of information")) Now, (describe-symbol 'foobar-baz) will include "an important piece of information". However, (describe-symbol 'foobar) will not: Name Type Default =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94 baz t nil ... even though the intention to include it can be seen by looking for the string ':documentation' in `cl--describe-class-slots`. This is because `cl--describe-class-slots` accidentally uses `alist-get` instead of `plist-get`. With the attached patch, (describe-symbol 'foobar) works as intended: Name Type Default Doc =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94= =E2=80=94=E2=80=94 baz t nil an important piece of information Note: `cl--describe-class-slot' (a different function) appears to have the same bug, but I have no idea how one would go about adding class slots to a struct and therefore no way of testing any changes to this other function. Could it be a code path that is never executed anyway? I decided to leave it alone, this patch should be an improvement regardless. --0000000000006cb2eb05bbc31090 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Given

=C2=A0 (require 'cl-macs)
=C2=A0 (cl-d= efstruct foobar
=C2=A0 =C2=A0 (baz nil :documentation "an important= piece of information"))

Now, (describe-symbol 'foobar-baz)= will include "an important piece of
information".

Howe= ver, (describe-symbol 'foobar) will not:

Name Type Default
= =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94
baz t n= il

... even though the intention to include it can be seen by lookin= g for
the string ':documentation' in `cl--describe-class-slots`.=

This is because `cl--describe-class-slots` accidentally uses
`al= ist-get` instead of `plist-get`.

With the attached patch, (describe-= symbol 'foobar) works as intended:

Name Type Default Doc
= =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94= =E2=80=94=E2=80=94
baz t nil an important piece of information

N= ote: `cl--describe-class-slot' (a different function) appears to havethe same bug, but I have no idea how one would go about adding class
s= lots to a struct and therefore no way of testing any changes to this
oth= er function.

Could it be a code path that is never executed anyway?= =C2=A0 I decided to
leave it alone, this patch should be an improvement = regardless.
--0000000000006cb2eb05bbc31090-- --0000000000006cb2ed05bbc31092 Content-Type: application/octet-stream; name="cl--describe-class-slots_plist-get.patch" Content-Disposition: attachment; filename="cl--describe-class-slots_plist-get.patch" Content-Transfer-Encoding: base64 Content-ID: X-Attachment-Id: f_kldnf36t0 RnJvbSBkOWI2NzA1MmE1OTVkMDNmMjI4YzYxZDA1YjA5MDZlYTc0YjBlZTRlIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBKdWxpYW4gU2NoZWlkIDxqdWxpYW5zMzdAZ21haWwuY29tPgpE YXRlOiBTdW4sIDIxIEZlYiAyMDIxIDAwOjE1OjUyICsxMzAwClN1YmplY3Q6IFtQQVRDSF0gY2wt ZXh0cmE6IEZpeCBkb2NzdHJpbmcgcmV0cmlldmFsCgoqIGxpc3AvZW1hY3MtbGlzcC9jbC1leHRy YS5lbCAoY2wtLWRlc2NyaWJlLWNsYXNzLXNsb3RzKTogRml4CiAgZG9jc3RyaW5nIHJldHJpZXZh bC4KLS0tCiBsaXNwL2VtYWNzLWxpc3AvY2wtZXh0cmEuZWwgfCA0ICsrLS0KIDEgZmlsZSBjaGFu Z2VkLCAyIGluc2VydGlvbnMoKyksIDIgZGVsZXRpb25zKC0pCgpkaWZmIC0tZ2l0IGEvbGlzcC9l bWFjcy1saXNwL2NsLWV4dHJhLmVsIGIvbGlzcC9lbWFjcy1saXNwL2NsLWV4dHJhLmVsCmluZGV4 IDI4Y2U2YjExNWEuLjg0MTk5YzE2MTIgMTAwNjQ0Ci0tLSBhL2xpc3AvZW1hY3MtbGlzcC9jbC1l eHRyYS5lbAorKysgYi9saXNwL2VtYWNzLWxpc3AvY2wtZXh0cmEuZWwKQEAgLTg5OCw4ICs4OTgs OCBAQCBjbC0tZGVzY3JpYmUtY2xhc3Mtc2xvdHMKICAgICAgICAgICAgICAgIChsaXN0IChjbC1w cmluMS10by1zdHJpbmcgKGNsLS1zbG90LWRlc2NyaXB0b3ItbmFtZSBzbG90KSkKICAgICAgICAg ICAgICAgICAgICAgIChjbC1wcmluMS10by1zdHJpbmcgKGNsLS1zbG90LWRlc2NyaXB0b3ItdHlw ZSBzbG90KSkKICAgICAgICAgICAgICAgICAgICAgIChjbC1wcmluMS10by1zdHJpbmcgKGNsLS1z bG90LWRlc2NyaXB0b3ItaW5pdGZvcm0gc2xvdCkpCi0gICAgICAgICAgICAgICAgICAgICAobGV0 ICgoZG9jIChhbGlzdC1nZXQgOmRvY3VtZW50YXRpb24KLSAgICAgICAgICAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgICAoY2wtLXNsb3QtZGVzY3JpcHRvci1wcm9wcyBzbG90KSkpKQor ICAgICAgICAgICAgICAgICAgICAgKGxldCAoKGRvYyAocGxpc3QtZ2V0IChjbC0tc2xvdC1kZXNj cmlwdG9yLXByb3BzIHNsb3QpCisgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICAgICAgOmRvY3VtZW50YXRpb24pKSkKICAgICAgICAgICAgICAgICAgICAgICAgKGlmIChub3Qg ZG9jKSAiIgogICAgICAgICAgICAgICAgICAgICAgICAgIChzZXRxIGhhcy1kb2MgdCkKICAgICAg ICAgICAgICAgICAgICAgICAgICAoc3Vic3RpdHV0ZS1jb21tYW5kLWtleXMgZG9jKSkpKSkKLS0g CjIuMzAuMQoK --0000000000006cb2ed05bbc31092--