From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Christopher Dimech Newsgroups: gmane.emacs.bugs Subject: bug#44043: Info Files Showing "see" or "*note" when using @ref in source Date: Sat, 17 Oct 2020 14:40:11 +0200 Message-ID: References: <831rhxuxco.fsf@gnu.org> <83blh1t6nj.fsf@gnu.org> 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="39151"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 44043-done@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Oct 17 17:30:10 2020 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 1kTo9q-000A6w-GB for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 17 Oct 2020 17:30:10 +0200 Original-Received: from localhost ([::1]:32896 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kTo9p-0007Ls-BF for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 17 Oct 2020 11:30:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49088) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kTo8l-00076L-Ao for bug-gnu-emacs@gnu.org; Sat, 17 Oct 2020 11:29:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:52037) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kTo8l-0004Um-1H for bug-gnu-emacs@gnu.org; Sat, 17 Oct 2020 11:29:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kTo8k-0002xE-Uf for bug-gnu-emacs@gnu.org; Sat, 17 Oct 2020 11:29:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Christopher Dimech Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 17 Oct 2020 15:29:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 44043 X-GNU-PR-Package: emacs Original-Received: via spool by 44043-done@debbugs.gnu.org id=D44043.160294852311312 (code D ref 44043); Sat, 17 Oct 2020 15:29:02 +0000 Original-Received: (at 44043-done) by debbugs.gnu.org; 17 Oct 2020 15:28:43 +0000 Original-Received: from localhost ([127.0.0.1]:35347 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kTo8R-0002wI-7P for submit@debbugs.gnu.org; Sat, 17 Oct 2020 11:28:43 -0400 Original-Received: from mout.gmx.net ([212.227.15.15]:50297) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kTlVS-0006v0-2m for 44043-done@debbugs.gnu.org; Sat, 17 Oct 2020 08:40:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1602938411; bh=w36p3+i0/9a3OJ/NRDuX5TUP7TVUFZb6Lq08Lv8ndQQ=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=af6/Ose4ho2XFnrizM4NkQyyoQ0zEaKUoAk8bW9YA/hvKc6P9RWAlBLL3O6TruVxp A82LKbQIEesngK1iWOwHZI5DhF38UTXB/xIZ/uLiHgh1xAGtPJGBbnJhHOw6oX6g68 Uw7tr/FjCaTvWaAGpKI5+FpvX4FSdx6jf0VDAIio= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from [213.165.168.94] ([213.165.168.94]) by web-mail.gmx.net (3c-app-mailcom-bs14.server.lan [172.19.170.182]) (via HTTP); Sat, 17 Oct 2020 14:40:11 +0200 Importance: normal Sensitivity: Normal In-Reply-To: <83blh1t6nj.fsf@gnu.org> X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:Wkkk3LkFlbxsRWb9wD18R9Y5BRCeVzMzxxmgUlfj0u4+r2YCkv8PbzFs6D8uGqG4x2o1Y wY4YlixRMWKCJRWbULhsKd/7huv0HtcX2s9nyhcaYpORhC2rmgagfcot9dbW3G0uzemoivAuUv7k IA7dKwrvVOu6eq5LfTTfJYANAFotxhWOsbXzjZBbjuhfYbqd/iKf+bduMlwCBtYn7ksaebqNHQn0 TmmDnxQTUAsTIHA7SMQfaIDEQMyvsnWYC1MGG+XQqd8RLioAZAasvzHFvyfdwIWzvFZY4itk9T46 SY= X-UI-Out-Filterresults: notjunk:1;V03:K0:Ik38/RI/bVI=:toEQkBfIGBDareg/4LSCEi BfEmXJZpML/2cfvYq1zEzyifBgqu6/wXoqgAxEUpdenrKeuBlW3DUSRqgWcSeMnk8uRVVJa/R zitB2I0+w4BGgH+lhn3d4TnIC+SrGhnZ2E0R3+2kngQyvnHrmO3KitFv1wrCVSeA6jR9fVX23 fZha2Jwfodt/7NcQtzb4pB1aLhX0jjhprTQGfnYX642A8Uxs9GZ3S0ZY93cZaSR1SRv0MuwRf O7yIxUf+gu33RXnuxb4qCMXEpaCbt8R1YTwi7Cz3hYvdbquprP/9MSSzk5h0beav0BiG+8u8z Y+UwDnVi4MfYRhiDyMqi07gjYwcYsJn3rwGH0LcCmN41OmtjFc5QPClqC0Y42l2VuT24xvM4f paUbhudr8VwcxrlSFDFsdiHtcuLyj64Tc86fvYqdcpwxoaoz3gMfh3GTEBLp1r5fbAKCBrSW9 bwID09PKPIn8UV2ceYkwW8qRUVmojZt9+uKxRC1n7KB933+elL2wLCT6/JzBFvdsQghy+38Sb frZm9BBIbNXAwokcnAoad+h69/Gy2OsvVV0o4zUQLfALN6MsknPg5WHAGDb0vOMfHxYqlxHat p6QTKl7gods1I= X-Mailman-Approved-At: Sat, 17 Oct 2020 11:28:40 -0400 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:190815 Archived-At: Yes, in the manual it can ignore the variable and not document every singl= e thing, but when a defaulted variable changes the output of what is expecte= d from the official texinfo behaviour, some documentation is required, as it was. Simply involved a little update, and a bit more clarity in descripti= on. Regards Christopher =2D-------------------- Christopher Dimech Administrator - Naiad Informatics - GNU Project (Geocomputation) - Geophysical Simulation - Geological Subsurface Mapping - Disaster Preparedness and Mitigation - Natural Resource Exploration and Production - Free Software Advocacy > Sent: Saturday, October 17, 2020 at 1:48 PM > From: "Eli Zaretskii" > To: "Christopher Dimech" > Cc: 44043-done@debbugs.gnu.org > Subject: Re: bug#44043: Info Files Showing "see" or "*note" when using @= ref in source > > > From: Christopher Dimech > > Cc: 44043@debbugs.gnu.org > > Date: Sat, 17 Oct 2020 12:47:17 +0200 > > > > The Emacs Manual does not mention hide so did not try it. Now > > that I have, the problem is resolved. The Emacs Manual needs > > to be updated as the option is not described. It only describes > > "t" and "nil". Here are the sections concerned: > > > > 1.5 Invisible text in Emacs Info > > 1.7 Following Cross-References > > 2.6 Emacs Info-mode Variables > > You mean, the Info mode manual, not the Emacs manual. > > I fixed the last one of these 3 sections, as only it includes the full > description of the variable, and the other two only discuss limited > effects of the variable. > > > Using M-x describe-variable Info-hide-note-references, > > although if would help with an improved documentation. > > Indeed, the doc string of a variable is the recommended place to look > first for the details of the variable. The manual could provide some > background and more elaborate info, but it could also completely > ignore the variable (we don't document every variable and every > function in our manuals). > > With that, I'm closing this bug report. Thanks. >