From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Emanuel Berg via Users list for the GNU Emacs text editor Newsgroups: gmane.emacs.help Subject: Re: Maintenance of *info* documentation of Emacs/Elisp Date: Sun, 23 Feb 2020 21:16:41 +0100 Message-ID: <87h7zh6ouu.fsf@ebih.ebihd> References: Reply-To: Emanuel Berg Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="105739"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) To: help-gnu-emacs@gnu.org Cancel-Lock: sha1:Lg0yB70xb70OUIUJuQqwinSAVzY= Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sun Feb 23 21:17:13 2020 Return-path: Envelope-to: geh-help-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 1j5xge-000ROA-VT for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 23 Feb 2020 21:17:12 +0100 Original-Received: from localhost ([::1]:56412 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j5xge-0000GD-1j for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 23 Feb 2020 15:17:12 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51366) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j5xgK-0000G1-8v for help-gnu-emacs@gnu.org; Sun, 23 Feb 2020 15:16:53 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j5xgI-0005hz-64 for help-gnu-emacs@gnu.org; Sun, 23 Feb 2020 15:16:51 -0500 Original-Received: from ciao.gmane.io ([159.69.161.202]:45070) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1j5xgH-0005hZ-Vg for help-gnu-emacs@gnu.org; Sun, 23 Feb 2020 15:16:50 -0500 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1j5xgE-000QvG-Ig for help-gnu-emacs@gnu.org; Sun, 23 Feb 2020 21:16:46 +0100 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: help-gnu-emacs@gnu.org Mail-Copies-To: never X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 159.69.161.202 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:122457 Archived-At: Greg Hill wrote: > After doing maybe an hour or so of additional > poking around in other parts of the *info* > documentation I eventually find a missing > detail that could have made my life a lot > easier and saved me a lot of time had it only > been mentioned in the right place. Well, that's always the case. And the/a challenge of writing documentation is not everyone is the same (thanks heaven), so the comment that is the eye opener for you, doesn't necessarily have the same effect on the next guy. So what one does is try to find the golden ratio that explains the most, to the most of people. > So my question is, is there someone who is in > charge of keeping the *info* documentation up > to date What you refer to as the *info* documentation isn't a homogeneous body of documentation. `info' is just a interface to a bunch of files that are written in the texinfo format. So for the Emacs FAQ, which you can get to like this: (info "efaq") you can find the texinfo source with this function: (defun info-find-source () (interactive) (let ((file (concat Info-current-file ".info"))) (if (file-exists-p file) (find-file-read-only file) (message "no file: %s (did you gunzip the info files?)" file) ))) ; [1] If you are apt with Emacs, but never quite got the hang of the *info* interface, it is often a good idea to just search the texinfo file. But to answer you question who to turn to, since a provider of software X will also provide its documentation, well, sometimes with a little help from their friends, but anyway, it is to the provider of the software you should turn with your suggestions as to how to improve the documentation. With Emacs, if you read the Elisp manual, you can just use `report-emacs-bug'. (It doesn't matter if it isn't a bug report, just a suggestion how to improve it.) Also, with Emacs in particular, I think you will be better helped by the built-in/on-line help system (on-line = not on paper). `C-h f' (`describe-function') to get the interface and documentation (the so called docstring) for a function, `C-h k' (`describe-key') for a key, and so on. You can try this now: `C-h k C-h k' Good luck! And ask more if it didn't make sense :) We can sure use people who are passionate about documentation... [1] https://dataswamp.org/~incal/emacs-init/my-info.el -- underground experts united http://user.it.uu.se/~embe8573 https://dataswamp.org/~incal