From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Ruslan Kiselev Newsgroups: gmane.emacs.devel Subject: Add examples to elisp method documentation Date: Sun, 12 Jun 2016 14:01:16 -0400 Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: ger.gmane.org 1465765477 21982 80.91.229.3 (12 Jun 2016 21:04:37 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 12 Jun 2016 21:04:37 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Jun 12 23:04:37 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 1bCCYe-0008MA-8w for ged-emacs-devel@m.gmane.org; Sun, 12 Jun 2016 23:04:36 +0200 Original-Received: from localhost ([::1]:52709 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bCCYd-0003nn-Hg for ged-emacs-devel@m.gmane.org; Sun, 12 Jun 2016 17:04:35 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44065) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bC9hG-0005p0-9z for emacs-devel@gnu.org; Sun, 12 Jun 2016 14:01:19 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bC9hF-0006tg-GZ for emacs-devel@gnu.org; Sun, 12 Jun 2016 14:01:18 -0400 Original-Received: from mail-it0-x22f.google.com ([2607:f8b0:4001:c0b::22f]:38211) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bC9hF-0006tV-Bx for emacs-devel@gnu.org; Sun, 12 Jun 2016 14:01:17 -0400 Original-Received: by mail-it0-x22f.google.com with SMTP id h190so28982715ith.1 for ; Sun, 12 Jun 2016 11:01:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:from:date:message-id:subject:to; bh=cfAMjfIOOvalZ/PMZwjZofSt3SXtPnrmWDBR1mdVS/E=; b=jg+kKibEKhcaR0DoTmKbVv8CZD0XRonXCE97b1hfZRur6YnbbXbWAwVE69bqprGMGy phDvCVlPGEx7SH5FCqGWNIuNhlWoIMkXytOXdiEWvIp2gq4zKuJrgsJ6Whp8YRXcR3p/ MB4rpHgP9KnT2SlyyOngdAeot90aWy882qaYGEZHtQac/2TD379u7Co2z5JfqecmJVOS GfSni+TdFND5UeydwfeeWF/awe3ojYyQaq0dGMa03B6JHM1OegThKRI86CahW85nVnam iwjNbmbix7hhO6aaokTzmaunoiS3bS3iqI0Wq9VRY0TWPVakVeGVFe1m7EHCC6nRrzRd 06dw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=cfAMjfIOOvalZ/PMZwjZofSt3SXtPnrmWDBR1mdVS/E=; b=eVa3wTc6SS0BnYLdl7Bgo1EuYlE5EilIcpvQ8cXyK17IYikbXAhqAQBdsGyK9ey0H+ GcRgRi42CGclTVYl8md4FWKjbgkogHOpYFJRU3omwAdmqShjBTxshzY13zkJxtrTSGCR mOrk+Z72mVwo61IMUmNtNVnT2O0YE6aiiKALaJvuQT7vr2f4XyKMtzY8p9IHcL2/2a7B XeNKrtjENmF47QDvtF9y7pPWDVrpcmJsz4i3wdLMGQ2H0kSOgVAjBqUMegD1QBGmgDN7 kmKgsXqGQtRBo2SQKFMi1kXdRwkDJavE0nmiXmAaUpkm+2BuaYeLRUrfjM4ekCro1+ih FEZA== X-Gm-Message-State: ALyK8tL4B0hMjgOlGm3t+CZaKS7ZL5/bq73deneyRHccrRGBuQZ/EUMd/3W2wbD9Ngri2UzgzuuHw2tDCk5fyg== X-Received: by 10.36.65.97 with SMTP id x94mr11874495ita.16.1465754476578; Sun, 12 Jun 2016 11:01:16 -0700 (PDT) Original-Received: by 10.107.6.93 with HTTP; Sun, 12 Jun 2016 11:01:16 -0700 (PDT) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:4001:c0b::22f X-Mailman-Approved-At: Sun, 12 Jun 2016 17:03:52 -0400 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:204321 Archived-At: Hopefully this is the correct place to aks for this. I'm relatively new to Emacs/Elisp. It would be extremely helpful if at least some Elisp function docs included examples. For example, (describe-function 'let) returns the following: let is a special form in `C source code'. (let VARLIST BODY...) Bind variables according to VARLIST then eval BODY. The value of the last form in BODY is returned. Each element of VARLIST is a symbol (which is bound to nil) or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). All the VALUEFORMs are evalled before any symbols are bound. Addition of an example would make it easier for beginners to understand/use: let is a special form in `C source code'. (let VARLIST BODY...) Bind variables according to VARLIST then eval BODY. The value of the last form in BODY is returned. Each element of VARLIST is a symbol (which is bound to nil) or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). All the VALUEFORMs are evalled before any symbols are bound. Example: (let ((apple "apple") (orange "orange") (banana "banana")) (message (format "Fruits: %s %s %s" apple orange banana))) I'd like to create a branch and work on adding snippets like this. It would help me learn Emacs's funcs and IMO help future Emacs users.