From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: "Basil L. Contovounesios" Newsgroups: gmane.emacs.bugs Subject: bug#30297: 27.0.50; *Help* shows inaccurate arglist for json-parse-string Date: Tue, 30 Jan 2018 23:31:29 +0000 Message-ID: <877eryylda.fsf@tcd.ie> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: blaine.gmane.org 1517364008 31763 195.159.176.226 (31 Jan 2018 02:00:08 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 31 Jan 2018 02:00:08 +0000 (UTC) To: 30297@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jan 31 03:00:03 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eghgq-0007cY-Mc for geb-bug-gnu-emacs@m.gmane.org; Wed, 31 Jan 2018 02:59:56 +0100 Original-Received: from localhost ([::1]:52797 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eghir-0008Q3-AK for geb-bug-gnu-emacs@m.gmane.org; Tue, 30 Jan 2018 21:02:01 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58386) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eghig-0008O7-Hv for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 21:01:51 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eghif-0006i7-JG for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 21:01:50 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:42132) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eghif-0006i1-BL for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 21:01:49 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eggta-0002vY-JV for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 20:09:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: "Basil L. Contovounesios" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 31 Jan 2018 01:09:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 30297 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.151736088511183 (code B ref -1); Wed, 31 Jan 2018 01:09:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 31 Jan 2018 01:08:05 +0000 Original-Received: from localhost ([127.0.0.1]:50014 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eggse-0002uJ-Qm for submit@debbugs.gnu.org; Tue, 30 Jan 2018 20:08:05 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:37782) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eggsc-0002tp-NC for submit@debbugs.gnu.org; Tue, 30 Jan 2018 20:08:03 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eggro-00045b-No for submit@debbugs.gnu.org; Tue, 30 Jan 2018 20:07:57 -0500 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:38753) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eggro-00044d-D8 for submit@debbugs.gnu.org; Tue, 30 Jan 2018 20:07:12 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52651) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eggqj-0008AU-VE for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 20:07:12 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eggpV-0000VG-FH for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 20:06:05 -0500 Original-Received: from mail-wm0-x236.google.com ([2a00:1450:400c:c09::236]:51244) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eggpV-0000Ta-2e for bug-gnu-emacs@gnu.org; Tue, 30 Jan 2018 20:04:49 -0500 Original-Received: by mail-wm0-x236.google.com with SMTP id r71so4840785wmd.1 for ; Tue, 30 Jan 2018 17:04:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd-ie.20150623.gappssmtp.com; s=20150623; h=from:to:subject:date:message-id:mime-version; bh=afWYCX/yzKs92HZaHFydBdbt7Ne03rSe9qs6h584UZY=; b=jeQ/jHo80byfhJTUVv6E1i+kEGRByua9HIrtbLjpdJ2PfkkNxKfbOvwUSoa5M8aqbQ x2jC/UI1et4hejK4dDo1IsugTAiW6V59XBYZ9POl0z+wd2ZQhQM9ofwQ9agTDwM6Ba+i gT2j0/TPZCk+kRi/JaXbtTHJW0PkMnmnUUzunBcDZxfT9IrxTwvIrfIeP+f0QYJFXCF3 gxDvP5CGgu2p3BnCrxzC72SgKQX00ojQs/w6/Y1orTWz2uhm34xHF7JTBrymaoVcWqFP FzZVnOal17Z+th9/djhIH0kGgrqTPsrmcmcY5IpmM3wTFz83h85C6gfRBj5Dap3NU7gy Jf4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:mime-version; bh=afWYCX/yzKs92HZaHFydBdbt7Ne03rSe9qs6h584UZY=; b=hQ3Eqf4S0defKl2zclsRooMfU9X53YXVcj35OwoznQ5DxvOV+R2YWVK/vIys0BTtya geehJWOK9s1KGNnJ5H0IhG8SfORklb3rL6boYj5zN+F9SQfo24om3wJ29Kow/nFm/i0P lXqTY4j/P/4IWHJEv/jASnjyPvefo4ca6124Mo+reX2HpxkSJY/qJkum6xILIt01BheI 57nsRlmkWtr7UN7eLvh6i/E5AKTe+2uy0nqA47SEAfmFEx+QVVXpJGfFDT/q+DQe/qkW tEjV3fC93shi4dLk+JvHkdKZliWUYwA8qvxpLp0mDbXf80u1ahoa9xOwmzoRLN+8cqH4 2/SA== X-Gm-Message-State: AKwxyteBUhc4g0mOee636RsrdwKxZk21eanf6Dz/Piyeq2MEW0YYR4ZP lb7mpkvwGJvYMQuqHixUjc8W+4lh X-Google-Smtp-Source: AH8x227RzbXNpkeoH8POEMtmAULXP/1t6NPc3gRqCl+xD6tpB8G4D4uxxvU2C0Yas+J5KVyt/0qMug== X-Received: by 10.80.204.73 with SMTP id n9mr54881709edi.69.1517355092243; Tue, 30 Jan 2018 15:31:32 -0800 (PST) Original-Received: from localhost ([2a02:8084:4f41:8c80:9c34:da08:a010:edfc]) by smtp.gmail.com with ESMTPSA id c90sm1375186edd.12.2018.01.30.15.31.30 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 30 Jan 2018 15:31:31 -0800 (PST) X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:142716 Archived-At: --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Fix-arglist-doc-of-json-parse-functions.patch >From 2ccc2700b2f2386a8792aa0fc1b2146b5c201e79 Mon Sep 17 00:00:00 2001 From: "Basil L. Contovounesios" Date: Tue, 30 Jan 2018 11:10:14 +0000 Subject: [PATCH] ; Fix arglist doc of json parse functions * src/json.c (Fjson_parse_string, Fjson_parse_buffer): Fix "usage:" arglist doc. --- src/json.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/json.c b/src/json.c index 12ba7afa6a..b046d34f66 100644 --- a/src/json.c +++ b/src/json.c @@ -740,7 +740,7 @@ object, all but the last one are ignored. If STRING doesn't contain a valid JSON object, an error of type `json-parse-error' is signaled. The keyword argument `:object-type' specifies which Lisp type is used to represent objects; it can be `hash-table' or `alist'. -usage: (string &key (OBJECT-TYPE \\='hash-table)) */) +usage: (json-parse-string STRING &key (OBJECT-TYPE \\='hash-table)) */) (ptrdiff_t nargs, Lisp_Object *args) { ptrdiff_t count = SPECPDL_INDEX (); @@ -813,7 +813,7 @@ DEFUN ("json-parse-buffer", Fjson_parse_buffer, Sjson_parse_buffer, This is similar to `json-parse-string', which see. Move point after the end of the object if parsing was successful. On error, point is not moved. -usage: (&key (OBJECT-TYPE \\='hash-table)) */) +usage: (json-parse-buffer &key (OBJECT-TYPE \\='hash-table)) */) (ptrdiff_t nargs, Lisp_Object *args) { ptrdiff_t count = SPECPDL_INDEX (); -- 2.15.1 --=-=-= Content-Type: text/plain Seen on latest master: 1. emacs -Q 2. C-h f json-parse-string RET *Help* reports the following arglist: (json-parse-string &key (OBJECT-TYPE 'hash-table)) despite mention of the positional argument STRING in the rest of the docstring. Attached is a doc fix suggestion. Thanks, -- Basil In GNU Emacs 27.0.50 (build 3, x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars) of 2018-01-30 built on thunk Repository revision: 2b0bcbbaa64f95c14deed89fdf279d8be48ee352 Windowing system distributor 'The X.Org Foundation', version 11.0.11905000 System Description: Debian GNU/Linux buster/sid Quit Configured using: 'configure --config-cache --prefix=/home/blc/.local --with-mailutils --with-x-toolkit=lucid --with-modules --with-file-notification=yes --with-x 'CFLAGS=-flto -fomit-frame-pointer -march=native -maes -mavx -mcrc32 -mf16c -mfpmath=sse -mfsgsbase -mfxsr -minline-all-stringops -mmmx -mpclmul -mpopcnt -msahf -msse4.2 -mxsave -mxsaveopt -mvzeroupper -O2 -pipe' LDFLAGS=-flto' Configured features: XAW3D XPM JPEG TIFF GIF PNG RSVG IMAGEMAGICK SOUND GPM DBUS GSETTINGS NOTIFY ACL LIBSELINUX GNUTLS LIBXML2 FREETYPE M17N_FLT LIBOTF XFT ZLIB TOOLKIT_SCROLL_BARS LUCID X11 MODULES THREADS LIBSYSTEMD JSON LCMS2 --=-=-=--