From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Michael Heerdegen Newsgroups: gmane.emacs.devel Subject: Re: Add examples to elisp method documentation Date: Mon, 13 Jun 2016 03:34:56 +0200 Message-ID: <87d1nl50sf.fsf@web.de> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1465781724 21061 80.91.229.3 (13 Jun 2016 01:35:24 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 13 Jun 2016 01:35:24 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Jun 13 03:35:15 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1bCGmY-0000Bc-L8 for ged-emacs-devel@m.gmane.org; Mon, 13 Jun 2016 03:35:14 +0200 Original-Received: from localhost ([::1]:53317 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bCGmX-0006Eo-W2 for ged-emacs-devel@m.gmane.org; Sun, 12 Jun 2016 21:35:14 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53192) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bCGmS-0006Cs-BF for emacs-devel@gnu.org; Sun, 12 Jun 2016 21:35:09 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bCGmO-0003LC-5H for emacs-devel@gnu.org; Sun, 12 Jun 2016 21:35:07 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:41373) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bCGmN-0003KW-U8 for emacs-devel@gnu.org; Sun, 12 Jun 2016 21:35:04 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1bCGmM-00004t-87 for emacs-devel@gnu.org; Mon, 13 Jun 2016 03:35:02 +0200 Original-Received: from dslb-094-217-122-112.094.217.pools.vodafone-ip.de ([94.217.122.112]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 13 Jun 2016 03:35:02 +0200 Original-Received: from michael_heerdegen by dslb-094-217-122-112.094.217.pools.vodafone-ip.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 13 Jun 2016 03:35:02 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 33 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: dslb-094-217-122-112.094.217.pools.vodafone-ip.de User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.94 (gnu/linux) Cancel-Lock: sha1:UT5EBVXru1xMLBW/PA3Qanr6HE8= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:204324 Archived-At: Ruslan Kiselev writes: > Hopefully this is the correct place to aks for this. I'm relatively > new to Emacs/Elisp. Welcome! > It would be extremely helpful if at least some Elisp function docs > included examples. Did you have a look at the Elisp (info) manual? That's the canonical place where examples are given and things are described in a broader way. Docstrings are intentionally concise. There is also an introduction into Emacs Lisp which offers more examples for basic stuff like `let'. You can read these manuals from within Emacs with the info reader (C-h i etc.) There is even a hotkey to search the Elisp manual for documentation about any specific command/function/option/variable (i.e. symbol): C-h S. All of these are part of the Emacs distribution. If you nevertheless find things under-documented, please send a bug report (preferably with M-x report-emacs-bug). You can include patches with suggestions of course. Regards, Michael.