From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Augusto Stoffel Newsgroups: gmane.emacs.devel Subject: Re: Documentation by function beyond elisp Date: Sat, 11 Mar 2023 11:46:15 +0100 Message-ID: <877cvnr2fc.fsf@gmail.com> References: <4Rj4EZNhsddTjHzoYuycFzMpjNTJjjwmdDcAgyuMcSFsBePmPBTtlxUENKjf4W1xOVcdDeZIFfHJxD9uRInDURGMdmiIPJ_BB1BvgQ8ylJI=@protonmail.com> <87lek5ynm6.fsf@localhost> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19156"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Yuri Khan , Ihor Radchenko , goncholden , "emacs-devel@gnu.org" To: Eshel Yaron Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Mar 11 11:47:22 2023 Return-path: Envelope-to: ged-emacs-devel@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 1pawky-0004oq-Jp for ged-emacs-devel@m.gmane-mx.org; Sat, 11 Mar 2023 11:47:20 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pawk3-0007AS-BC; Sat, 11 Mar 2023 05:46:23 -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 1pawk1-0007A4-N2 for emacs-devel@gnu.org; Sat, 11 Mar 2023 05:46:21 -0500 Original-Received: from mail-ed1-x533.google.com ([2a00:1450:4864:20::533]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pawjz-000092-US for emacs-devel@gnu.org; Sat, 11 Mar 2023 05:46:21 -0500 Original-Received: by mail-ed1-x533.google.com with SMTP id r15so3380205edq.11 for ; Sat, 11 Mar 2023 02:46:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1678531578; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=9MMtrDZjfbAWHj8ZN4dI2+GExjROLmACrlskyyi1FWE=; b=pUuIyO4ztOsc5WcH0/zgoWquYxi5HTIvTfQ6vrPCB4cZ1JBiEg78MM9iWVkYjhOsZT fFUFp97pg0CA0Xldyn+1qt93Q1gq9GTW6Q2V3eRxnhgAD3DR0AWoMAcVMALP1fMRq1Qs 4/GSoUH+l0/hF6zytiG//HKtUdny4Qc2x/YiAyg3hX9/KhUJiTFvjy+Kxx6ZFwI8Hv+N do98ZrMVfx6MHazQkPgwaYMQB7isgWgHrD+iFKIRRa6+zixFt44pxFVLNNaNvmBpsO0k /PihqQI/ClhaVz5MqOFOtY3PH9wkPRx1i1j5DrHv7/XJfFal2Rhl9zWCfvQxuudQaHju fzBw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678531578; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=9MMtrDZjfbAWHj8ZN4dI2+GExjROLmACrlskyyi1FWE=; b=k0UI8mggKxR7sWQ9jWPzw3ZOwtMV09Z+xNooNkFoBnBrBmThNnkeIn90nq3b0IkcYI ArEqQyTVGflYJiOURXqJjZSrsRLu/gjrSZFt1Su1PubQfYzVBjPQwPWInTM5GoEdjcxF l/ljHH9YRPCBw9mA38JRBn5vgF+AopR6CDCCAM/mRfxc8FSmtM5qdvasRoBpMJ7AChy5 LVfkWMB1WJOlUzJZyDveOu7/y7Gp44n7WSUUbU7RSP8gtoK5ino0rlbBb4WrgC3IXZZa EbyWYQlQNdfP0AmtRyElbI9JeJ74oYQ0H137bvzBIbsrz7q+ZQFmrL7esFAZBmn1leHJ YFPw== X-Gm-Message-State: AO0yUKXJEvYo1QPr65i6+y1I1cfDLZCy7k9rsq43Voufr88l2wvePY5x BzMBMinYzaJzimdrxws/SZzrFgGzxKDyvw== X-Google-Smtp-Source: AK7set9CH/eR/yAkdA1N0cfUclUrl3L+OXUXo0yqJowGVanAWLhuJ7GCYtuJTj7uMejaHPz5S4bYfg== X-Received: by 2002:a17:906:2da2:b0:889:7781:f62e with SMTP id g2-20020a1709062da200b008897781f62emr26572687eji.22.1678531577749; Sat, 11 Mar 2023 02:46:17 -0800 (PST) Original-Received: from ars3 ([2a02:8109:8ac0:56d0::8b3a]) by smtp.gmail.com with ESMTPSA id b18-20020a17090636d200b008d0dbf15b8bsm943795ejc.212.2023.03.11.02.46.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 11 Mar 2023 02:46:17 -0800 (PST) In-Reply-To: (Eshel Yaron's message of "Fri, 10 Mar 2023 16:50:29 +0200") Received-SPF: pass client-ip=2a00:1450:4864:20::533; envelope-from=arstoffel@gmail.com; helo=mail-ed1-x533.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 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:304282 Archived-At: On Fri, 10 Mar 2023 at 16:50, Eshel Yaron wrote: > IMO ElDoc and Help and two pretty different features, each with its own > use and purpose. > Eglot integrates with ElDoc but not with Help AFAIU, Right, the LSP protocol doesn't have an interface for anything like `C-h o'. You only get information on the symbol at point. > but language-specific packages can (and should!) integrate with both of > these facilities. Emacs lets package authors reuse the Help UI pretty > easily. For example, my package sweeprolog.el (for working with > SWI-Prolog code) provides both ElDoc integration and a command > sweeprolog-describe-predicate that works much like describe-predicate, > it uses the help.el interface to show a proper *Help* buffer with the > documentation of a given Prolog predicate. The generic Emacs way to provide this functionality is the Info symbol lookup command `C-h S'. If your language doesn't have an Info manual you may have better luck with the `devdocs' package (which I mention as a shameless but pertinent plug). Out of curiosity: apart from the issue of availability of documentation in different formats, is there any prolog-specific logic in sweeprolog-describe-predicate?