From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Kaushal Modi Newsgroups: gmane.emacs.bugs Subject: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp form API Date: Thu, 7 Apr 2022 23:52:32 -0400 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="00000000000060d3ae05dc1c88fa" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="30128"; mail-complaints-to="usenet@ciao.gmane.io" To: 54782@debbugs.gnu.org, larsi@gnus.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Apr 08 05:54:17 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 1ncfhQ-0007hq-Ci for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 08 Apr 2022 05:54:16 +0200 Original-Received: from localhost ([::1]:34676 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ncfhO-0007n2-WC for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 07 Apr 2022 23:54:15 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41972) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ncfhE-0007mt-07 for bug-gnu-emacs@gnu.org; Thu, 07 Apr 2022 23:54:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:39846) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ncfhD-0000aq-Nb for bug-gnu-emacs@gnu.org; Thu, 07 Apr 2022 23:54:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ncfhD-0003eT-HQ for bug-gnu-emacs@gnu.org; Thu, 07 Apr 2022 23:54:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Kaushal Modi Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 08 Apr 2022 03:54:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 54782 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org, Lars Ingebrigtsen Original-Received: via spool by submit@debbugs.gnu.org id=B.164938999413976 (code B ref -1); Fri, 08 Apr 2022 03:54:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 8 Apr 2022 03:53:14 +0000 Original-Received: from localhost ([127.0.0.1]:33743 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ncfgQ-0003dM-AU for submit@debbugs.gnu.org; Thu, 07 Apr 2022 23:53:14 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:50420) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ncfgO-0003dC-DA for submit@debbugs.gnu.org; Thu, 07 Apr 2022 23:53:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41918) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ncfgO-0007jY-2H for bug-gnu-emacs@gnu.org; Thu, 07 Apr 2022 23:53:12 -0400 Original-Received: from mail-pl1-x636.google.com ([2607:f8b0:4864:20::636]:33327) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ncfgM-0000Y9-MH for bug-gnu-emacs@gnu.org; Thu, 07 Apr 2022 23:53:11 -0400 Original-Received: by mail-pl1-x636.google.com with SMTP id c23so6869882plo.0 for ; Thu, 07 Apr 2022 20:53:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:from:date:message-id:subject:to; bh=qlwV1tgBZW6g8UE1ZqI+9sm5XLsuBM5NmHgQ62BKF7w=; b=Z9ketcpql7Jx6OGxXxrX6uERFtNodJYluFDUU5uTCO3MKZQuTqpiORwMWkLnSdH1Fm cG/3RE7h6YULF08FdvYXzVuBAjbx95r4Na0LIzcKAahtcRPLw+BRiJmjM+o9ToR5yGLM VecucVBACuuNYPy240Xp/rtqa5+xDXALhiJQoyDxx6sqyfCqAPpduktgNFwenbWazKgY ghQlFdrgdm7e7IFJyGxOMJHTRJQgTySLpqTuEp0EFIghdZIzjdAsovnM9BU3u6gbUCg5 iurmK2KYnfbaeo0rjFhLY04FoNi1vx2/ty/eo1qPuTfkKn3HsNDajb7xWsclmdSVgJXw Yf8w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=qlwV1tgBZW6g8UE1ZqI+9sm5XLsuBM5NmHgQ62BKF7w=; b=03Gjwe4jidcWYmPGgSnOapFJCtANGrkaiDya2kwb13IafAWW461gWxkZt5siByTAHH 5FNiURKU8RalfMVgAydBn6ZrITAGKerPb7yy591DeEYdnWEK4OmbaYYHtFbJewENc+3t d0LVbiL2VP+KVzmdAxZUkr4RhS91G58wUDJJLVef7qCx3abYRfbMMbPTlkHFW4ivmOqX nHbVDS7b7yjpWaFN6POkRX6EjEVUO+Rxb6TQQfYs0yFeI0Xv1ijdebJyADZTdDOxILLf ENtmq3cmM7OHEwnv0wm1+wvpdP/dHUNRmrtyvTpAA1hU1HnQsKYVmrZDXUCxn9KuEbVJ FIIg== X-Gm-Message-State: AOAM532yyZbtqHHJ8RciO4utGyep9XrE/qPZCC9zcPv+5UtienltErhc ijD/hAat74HO2Palm5zLeSuhb3Zcp82g33bTe8fWfk4SSQo= X-Google-Smtp-Source: ABdhPJxfRcq7bbyVgHrt32/N42FwKFcRUU+Ici4P56LHJJRaGRhTjOBpWFu7be5SiPZAucbmljhuNDo87hKFPcTD3Lk= X-Received: by 2002:a17:90b:1902:b0:1ca:9793:bf28 with SMTP id mp2-20020a17090b190200b001ca9793bf28mr19135952pjb.51.1649389988787; Thu, 07 Apr 2022 20:53:08 -0700 (PDT) Received-SPF: pass client-ip=2607:f8b0:4864:20::636; envelope-from=kaushal.modi@gmail.com; helo=mail-pl1-x636.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, T_SCC_BODY_TEXT_LINE=-0.01 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:229548 Archived-At: --00000000000060d3ae05dc1c88fa Content-Type: text/plain; charset="UTF-8" Hello, I have reading through the shortdoc documentation and in the process ended up with these edits. Can someone please review this? I have my copyright assigned and I have access to the Emacs git repo. But I cannot access it via git/SSH protocol (due to technical reasons at work). So once the patch is ready, I'll need someone's help to commit it as well. Thanks! -- Kaushal Modi --00000000000060d3ae05dc1c88fa Content-Type: application/octet-stream; name="0001-Update-docstrings-for-shortdoc.el-FUNC-lisp-form-API.patch" Content-Disposition: attachment; filename="0001-Update-docstrings-for-shortdoc.el-FUNC-lisp-form-API.patch" Content-Transfer-Encoding: base64 Content-ID: X-Attachment-Id: f_l1pw620x0 RnJvbSA1MmNmYzU5YjI4NTcxYmE1YzA2MDg0YWM3YzFmMzhmNGE1NmRjYzZmIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBLYXVzaGFsIE1vZGkgPGthdXNoYWwubW9kaUBnbWFpbC5jb20+ CkRhdGU6IFRodSwgNyBBcHIgMjAyMiAxNToxNTo1OCAtMDQwMApTdWJqZWN0OiBbUEFUQ0hdIFVw ZGF0ZSBkb2NzdHJpbmdzIGZvciBzaG9ydGRvYy5lbCBGVU5DIGxpc3AgZm9ybSBBUEkKCiogbGlz cC9lbWFjcy1saXNwL3Nob3J0ZG9jLmVsIChkZWZpbmUtc2hvcnQtZG9jdW1lbnRhdGlvbi1ncm91 cCkKKHNob3J0ZG9jLWFkZC1mdW5jdGlvbik6IFVwZGF0ZWQgZG9jc3RyaW5ncy4KLS0tCiBsaXNw L2VtYWNzLWxpc3Avc2hvcnRkb2MuZWwgfCA3MSArKysrKysrKysrKysrKysrKysrKysrKysrKysr Ky0tLS0tLS0tCiAxIGZpbGUgY2hhbmdlZCwgNTcgaW5zZXJ0aW9ucygrKSwgMTQgZGVsZXRpb25z KC0pCgpkaWZmIC0tZ2l0IGEvbGlzcC9lbWFjcy1saXNwL3Nob3J0ZG9jLmVsIGIvbGlzcC9lbWFj cy1saXNwL3Nob3J0ZG9jLmVsCmluZGV4IDk5MDM1YzllODkuLjZmZDRkNDE1NjQgMTAwNjQ0Ci0t LSBhL2xpc3AvZW1hY3MtbGlzcC9zaG9ydGRvYy5lbAorKysgYi9saXNwL2VtYWNzLWxpc3Avc2hv cnRkb2MuZWwKQEAgLTQ3LDMwICs0Nyw3MCBAQCBkZWZpbmUtc2hvcnQtZG9jdW1lbnRhdGlvbi1n cm91cAogICAiQWRkIEdST1VQIHRvIHRoZSBsaXN0IG9mIGRlZmluZWQgZG9jdW1lbnRhdGlvbiBn cm91cHMuCiBGVU5DVElPTlMgaXMgYSBsaXN0IG9mIGVsZW1lbnRzIG9uIHRoZSBmb3JtOgogCi0g IChmdW4KKyAgKEZVTkMKICAgIDpuby1tYW51YWwgQk9PTAogICAgOmFyZ3MgQVJHUwotICAgOmV2 YWwgRVhBTVBMRS1GT1JNCisgICA6ZXZhbCBFVkFMCiAgICA6bm8tZXZhbCBFWEFNUExFLUZPUk0K LSAgIDpuby1ldmFsKiBFWEFNUExFLUZPUk0KICAgIDpuby12YWx1ZSBFWEFNUExFLUZPUk0KKyAg IDpuby1ldmFsKiBFWEFNUExFLUZPUk0KICAgIDpyZXN1bHQgUkVTVUxULUZPUk0KLSAgIDpyZXN1 bHQtc3RyaW5nIFJFU1VMVC1GT1JNCisgICA6cmVzdWx0LXN0cmluZyBSRVNVTFQtU1RSSU5HCiAg ICA6ZWctcmVzdWx0IFJFU1VMVC1GT1JNCi0gICA6ZWctcmVzdWx0LXN0cmluZyBSRVNVTFQtRk9S TSkKKyAgIDplZy1yZXN1bHQtc3RyaW5nIFJFU1VMVC1TVFJJTkcpCiAKLUJPT0wgc2hvdWxkIGJl IG5vbi1uaWwgaWYgdGhlIGZ1bmN0aW9uIGlzbid0IGRvY3VtZW50ZWQgaW4gdGhlCitGVU5DIGlz IHRoZSBmdW5jdGlvbiBiZWluZyBkb2N1bWVudGVkLgorCitOTy1NQU5VQUwgc2hvdWxkIGJlIG5v bi1uaWwgaWYgRlVOQyBpc24ndCBkb2N1bWVudGVkIGluIHRoZQogbWFudWFsLgogCi1BUkdTIGlz IG9wdGlvbmFsOyB0aGUgZnVuY3Rpb24ncyBzaWduYXR1cmUgaXMgZGlzcGxheWVkIGlmIEFSR1MK LWlzIG5vdCBwcmVzZW50LgorQVJHUyBpcyBvcHRpb25hbCBsaXN0IG9mIGZ1bmN0aW9uIEZVTkMn cyBhcmd1bWVudHMuICBGVU5DJ3MKK3NpZ25hdHVyZSBpcyBkaXNwbGF5ZWQgYXV0b21hdGljYWxs eSBpZiBBUkdTIGlzIG5vdCBwcmVzZW50LgorU3BlY2lmeWluZyBBUkdTIG1pZ2h0IGJlIHVzZWZ1 bCB3aGVyZSB5b3UgZG9uJ3Qgd2FudCB0byBkb2N1bWVudAorc29tZSBvZiB0aGUgdW5jb21tb24g YXJndW1lbnRzIGEgZnVuY3Rpb24gbWlnaHQgaGF2ZS4KKworV2hpbGUgdGhlIGA6bm8tbWFudWFs JyBhbmQgYDphcmdzJyBwcm9wZXJ0eSBjYW4gYmUgdXNlZCBmb3IKK2FueSAoRlVOQyAuLikgZm9y bSwgYWxsIG9mIHRoZSBvdGhlciBwcm9wZXJ0aWVzIHNob3duIGFib3ZlCitjYW5ub3QgYmUgdXNl ZCBzaW11bHRhbmVvdXNseSBpbiBzdWNoIGEgZm9ybS4KKworSGVyZSBhcmUgc29tZSBjb21tb24g Zm9ybXMgd2l0aCBleGFtcGxlcyBvZiBwcm9wZXJ0aWVzIHRoYXQgZ28KK3RvZ2V0aGVyOgorCisx LiBEb2N1bWVudCBhIGZvcm0gb3Igc3RyaW5nLCBhbmQgaXRzIGV2YWx1YXRlZCByZXR1cm4gdmFs dWUuCisgICAoRlVOQworICAgIDpldmFsIEVWQUwpCiAKIElmIEVWQUwgaXNuJ3QgYSBzdHJpbmcs IGl0IHdpbGwgYmUgcHJpbnRlZCB3aXRoIGBwcmluMScsIGFuZCB0aGVuCi1ldmFsdWF0ZWQgdG8g Z2l2ZSBhIHJlc3VsdCwgd2hpY2ggaXMgYWxzbyBwcmludGVkLiAgSWYgaXQncyBhCi1zdHJpbmcs IGl0J2xsIGJlIGluc2VydGVkIGFzIGlzLCB0aGVuIHRoZSBzdHJpbmcgd2lsbCBiZSBgcmVhZCcs Ci1hbmQgdGhlbiBldmFsdWF0ZWQuCitldmFsdWF0ZWQgdG8gZ2l2ZSBhIHJlc3VsdCwgd2hpY2gg aXMgYWxzbyBwcmludGVkLgorCitJZiBFVkFMIGlzIGEgc3RyaW5nLCBpdCB3aWxsIGJlIGluc2Vy dGVkIGFzIGlzLCBhbmQgdGhlbiB0aGF0CitzdHJpbmcgd2lsbCBiZSBgcmVhZCcgYW5kIGV2YWx1 YXRlZC4KKworMi4gRG9jdW1lbnQgYSBmb3JtIG9yIHN0cmluZywgYnV0IG1hbnVhbGx5IGRvY3Vt ZW50IGl0cyBldmFsYXRpb24KKyAgIHJlc3VsdC4gIFRoZSBwcm92aWRlZCBmb3JtIHdpbGwgbm90 IGJlIGV2YWx1YXRlZC4KIAotVGhlcmUgY2FuIGJlIGFueSBudW1iZXIgb2YgOmV4YW1wbGUvOnJl c3VsdCBlbGVtZW50cy4iCisgIChGVU5DCisgICA6bm8tZXZhbCBFWEFNUExFLUZPUk0KKyAgIDpy ZXN1bHQgUkVTVUxULUZPUk0gICA7VXNlIGA6cmVzdWx0LXN0cmluZycgaWYgdmFsdWUgaXMgaW4g c3RyaW5nIGZvcm0KKyAgICkKKworVXNpbmcgYDpuby12YWx1ZScgaXMgdGhlIHNhbWUgYXMgdXNp bmcgYDpuby1ldmFsJy4KKworVXNlIGA6bm8tZXZhbConIGluc3RlYWQgb2YgYDpuby1ldmFsJyB3 aGVyZSB0aGUgc3VjY2Vzc2Z1bAorZXhlY3V0aW9uIG9mIHRoZSBkb2N1bWVudGVkIGZvcm0gZGVw ZW5kcyBvbiBzb21lIGNvbmRpdGlvbnMuCisKKzMuIERvY3VtZW50IGEgZm9ybSBvciBzdHJpbmcg RVhBTVBMRS1GT1JNLiAgQWxzbyBtYW51YWxseQorICAgZG9jdW1lbnQgYW4gZXhhbXBsZSByZXN1 bHQuICBUaGlzIHJlc3VsdCBjb3VsZCBiZSB1bnJlbGF0ZWQgdG8KKyAgIHRoZSBkb2N1bWVudGVk IGZvcm0uCisKKyAgKEZVTkMKKyAgIDpuby1ldmFsIEVYQU1QTEUtRk9STQorICAgOmVnLXJlc3Vs dCBSRVNVTFQtRk9STSA7VXNlIGA6ZWctcmVzdWx0LXN0cmluZycgaWYgdmFsdWUgaXMgaW4gc3Ry aW5nIGZvcm0KKyAgICkKKworQSBGVU5DIGZvcm0gY2FuIGhhdmUgYW55IG51bWJlciBvZiBgOm5v LWV2YWwnIChvciBgOm5vLXZhbHVlJyksCitgOm5vLWV2YWwqJywgYDpyZXN1bHQnLCBgOnJlc3Vs dC1zdHJpbmcnLCBgOmVnLXJlc3VsdCcgYW5kCitgOmVnLXJlc3VsdC1zdHJpbmcnIHByb3BlcnRp ZXMuIgogICBgKHByb2duCiAgICAgIChzZXRxIHNob3J0ZG9jLS1ncm91cHMgKGRlbHEgKGFzc3Eg Jyxncm91cCBzaG9ydGRvYy0tZ3JvdXBzKQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICAgIHNob3J0ZG9jLS1ncm91cHMpKQpAQCAtMTM1MSwxMSArMTM5MSwxNCBAQCBzaG9ydGRvYy1h ZGQtZnVuY3Rpb24KIElmIEdST1VQIGRvZXNuJ3QgZXhpc3QsIGl0IHdpbGwgYmUgY3JlYXRlZC4K IElmIFNFQ1RJT04gZG9lc24ndCBleGlzdCwgaXQgd2lsbCBiZSBhZGRlZC4KIAorRUxFTSBpcyBh IExpc3AgZm9ybS4gIFNlZSBgZGVmaW5lLXNob3J0LWRvY3VtZW50YXRpb24tZ3JvdXAnIGZvcgor ZGV0YWlscy4KKwogRXhhbXBsZToKIAogICAoc2hvcnRkb2MtYWRkLWZ1bmN0aW9uCi0gICAgJ2Zp bGUgXCJQcmVkaWNhdGVzXCIKLSAgICAnKGZpbGUtbG9ja2VkLXAgOm5vLWV2YWwgKGZpbGUtbG9j a2VkLXAgXCIvdG1wXCIpKSkiCisgICAgXFw9J2ZpbGUgXCJQcmVkaWNhdGVzXCIKKyAgICBcXD0n KGZpbGUtbG9ja2VkLXAgOm5vLWV2YWwgKGZpbGUtbG9ja2VkLXAgXCIvdG1wXCIpKSkiCiAgIChs ZXQgKChnbGlzdCAoYXNzcSBncm91cCBzaG9ydGRvYy0tZ3JvdXBzKSkpCiAgICAgKHVubGVzcyBn bGlzdAogICAgICAgKHNldHEgZ2xpc3QgKGxpc3QgZ3JvdXApKQotLSAKMi4zNC4wCgo= --00000000000060d3ae05dc1c88fa--