From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "Basil L. Contovounesios" Newsgroups: gmane.emacs.bugs Subject: bug#47109: eldoc.el: Allow custom separator between documentations in the echo area Date: Fri, 12 Mar 2021 21:13:51 +0000 Message-ID: <87o8foaxdc.fsf@tcd.ie> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="535"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= , 47109@debbugs.gnu.org To: Mathieu Marques Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Mar 12 22:15:13 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 1lKp7p-000AbP-7s for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 12 Mar 2021 22:15:13 +0100 Original-Received: from localhost ([::1]:36292 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lKp7o-0008BV-2S for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 12 Mar 2021 16:15:12 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35670) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lKp7e-00088t-A8 for bug-gnu-emacs@gnu.org; Fri, 12 Mar 2021 16:15:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47001) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lKp7e-0003Yo-0v for bug-gnu-emacs@gnu.org; Fri, 12 Mar 2021 16:15:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lKp7d-0002gN-RH for bug-gnu-emacs@gnu.org; Fri, 12 Mar 2021 16:15:01 -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: Fri, 12 Mar 2021 21:15:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 47109 X-GNU-PR-Package: emacs Original-Received: via spool by 47109-submit@debbugs.gnu.org id=B47109.161558364710214 (code B ref 47109); Fri, 12 Mar 2021 21:15:01 +0000 Original-Received: (at 47109) by debbugs.gnu.org; 12 Mar 2021 21:14:07 +0000 Original-Received: from localhost ([127.0.0.1]:58547 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lKp6k-0002eg-OZ for submit@debbugs.gnu.org; Fri, 12 Mar 2021 16:14:07 -0500 Original-Received: from mail-wm1-f50.google.com ([209.85.128.50]:53887) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lKp6e-0002dc-Uv for 47109@debbugs.gnu.org; Fri, 12 Mar 2021 16:14:03 -0500 Original-Received: by mail-wm1-f50.google.com with SMTP id g20so4597689wmk.3 for <47109@debbugs.gnu.org>; Fri, 12 Mar 2021 13:14:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd.ie; s=google21; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=8DbY1D9QBYByWpN572USrxgzJRdRw8GMYyUrPjBVXZA=; b=UXyNso17FV1JFB5rQLtKpw7Rf8c2TeqdakLDrKdFdY7D5vdgeDgfkBgbnDtWvaBPzX J8t0npX5HOfu+S8sWLYJyISSOCmOCg/0rtxC4jW0XYN3Y0R0otiEDb/hU+FYMxeu/QqV T+DADG0oS7Chq4vsL2LHUyYDvoYUzw4Q2lLcMYgkS4UyuAqFTrdtv1aGMC5UG0zFUssB hs5BxT8LO/ncMkI/olBZ1ep940rEzlrln8fJqWwiDISFTP/KK2ODT4+ij5DgqxpA4+pe xagueMTYg1WTm1zlFVnGDoi/giQdy5JDyqE5DwTZMKdMVRNAh3mWKlCf1vWhOuyyhnnQ VREw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=8DbY1D9QBYByWpN572USrxgzJRdRw8GMYyUrPjBVXZA=; b=JHCl9SDlBJMbEqJ2V18pjtHaTNCU+W2O+zu+F8ggxkYZ6OxA7bGel/gmwJmYhO709p y5a4+HQyui9zuaY1J4s+AWWVzt6vTQBzjZmlML/dRh8oF+01vBUXhmoixDpwzWRHdBsM kl8UX4TxmwTYww1gbTDjgzz3raS1yoUHS8NVKJCCTGONZhGyfyhVQU4x9OQ6W7hfhkCe nU6lP0KEa1jkyFpa/WqxTw0WXZNweCylFi6eoaOfAsfNpH/7F1ONSOTA/JWmz/Drd8GZ 2c9v9Iq5lhaLXgTdQghMuNVS625ZsE96XZqmI5qk7xDWRwf5x4My+NJdx0chnVgVjw1Z X+ww== X-Gm-Message-State: AOAM5301pNOJecMo8q02r5kaTdsHhvmM5TIn8YN95fpDaqk8gXmfyIpM MG5MfILMit64905z28319PGRLQ== X-Google-Smtp-Source: ABdhPJzYMpqMeXfQWuqYzGVm9asMhRQlTdA80t2V9eLZhCoCd4LbSSKgZl8rfwpsSDCe07M+Tj4EOQ== X-Received: by 2002:a1c:a916:: with SMTP id s22mr15217528wme.82.1615583634089; Fri, 12 Mar 2021 13:13:54 -0800 (PST) Original-Received: from localhost ([2a02:8084:20e2:c380:f410:82e8:3a21:eedf]) by smtp.gmail.com with ESMTPSA id j12sm9346330wrx.59.2021.03.12.13.13.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 13:13:53 -0800 (PST) In-Reply-To: (Mathieu Marques's message of "Fri, 12 Mar 2021 20:10:17 +0100") 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:202209 Archived-At: severity 47109 wishlist tags 47109 patch quit Mathieu Marques writes: > While trying out eglot.el, I played around with eldoc.el and needed to > display all pieces of documentations in the echo area at once. The > joined patch allows for a custom separator between said > documentations. Thanks, CCing Jo=C3=A3o as an expert on both packages. > First patch is a fix to indenting levels as well as untabifying the > whole file. That was done automatically by my configuration and given > the existing code I thought it would be beneficial to most to provide > a patch for that as well. Feel free to dismiss it if needed. Indeed, the Emacs convention is to only make whitespace/formatting changes when already modifying that code for other purposes. > Subject: [PATCH 2/2] * lisp/emacs-lisp/eldoc.el (eldoc--format-doc-buffer= ): > Allow custom separator The log message should also mention the new symbols being added, e.g.: Make ElDoc separator customizable * lisp/emacs-lisp/eldoc.el (eldoc-documentation-separator): New user option (bug#47109). (eldoc-documentation-separator): New face. (eldoc--format-doc-buffer): Use them as a custom separator. > +(defcustom eldoc-documentation-separator "" > + "Separator to use between each documentation thing, when multiple." > + :type 'string) > + > +(defface eldoc-documentation-separator '((t (:extend t :inherit shadow))) According to (info "(elisp) Defining Faces"), this syntax is supported for backward compatibility; nowadays the preferred format is: '((t :inherit shadow :extend t)) But: ElDoc supports Emacs =E2=89=A5 26.3, so use of the newer :extend attri= bute has to be conditional on that, e.g.: `((t :inherit shadow ,@(and (>=3D emacs-major-version 27) '(:extend t)))) > + "Face to use for the separator between documentation things.") Both the defcustom and the defface also need a :version tag. Thanks, --=20 Basil