From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Emanuel Berg Newsgroups: gmane.emacs.help Subject: docstrings (was: Re: Add-on USB custom keypads) Date: Fri, 17 Jun 2016 08:15:13 +0200 Message-ID: <86vb185ojy.fsf_-_@student.uu.se> References: <20160616200035.GB3431@mail.akwebsoft.com> <86wplo7run.fsf@student.uu.se> <20160616223429.GC3431@mail.akwebsoft.com> <86mvmk7nzb.fsf@student.uu.se> <20160617003959.GD3431@mail.akwebsoft.com> <86inx87gr3.fsf@student.uu.se> <20160617020301.GE3431@mail.akwebsoft.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1466144168 28908 80.91.229.3 (17 Jun 2016 06:16:08 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 17 Jun 2016 06:16:08 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Fri Jun 17 08:16:01 2016 Return-path: Envelope-to: geh-help-gnu-emacs@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 1bDn4S-0000fr-Sv for geh-help-gnu-emacs@m.gmane.org; Fri, 17 Jun 2016 08:16:01 +0200 Original-Received: from localhost ([::1]:54115 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bDn4O-0006je-UC for geh-help-gnu-emacs@m.gmane.org; Fri, 17 Jun 2016 02:15:56 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46847) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bDn3x-0006jY-8u for help-gnu-emacs@gnu.org; Fri, 17 Jun 2016 02:15:30 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bDn3s-0003cj-5H for help-gnu-emacs@gnu.org; Fri, 17 Jun 2016 02:15:29 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:54888) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bDn3r-0003cd-UX for help-gnu-emacs@gnu.org; Fri, 17 Jun 2016 02:15:24 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1bDn3p-0000Hu-GR for help-gnu-emacs@gnu.org; Fri, 17 Jun 2016 08:15:21 +0200 Original-Received: from c-9ce1e655.08-680-7570702.cust.bredbandsbolaget.se ([85.230.225.156]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 17 Jun 2016 08:15:21 +0200 Original-Received: from embe8573 by c-9ce1e655.08-680-7570702.cust.bredbandsbolaget.se with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 17 Jun 2016 08:15:21 +0200 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: help-gnu-emacs@gnu.org Original-Lines: 61 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: c-9ce1e655.08-680-7570702.cust.bredbandsbolaget.se User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4 (gnu/linux) Mail-Copies-To: never Cancel-Lock: sha1:JMh+gzn0m5uffHFpNHllY9hkCl0= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.org gmane.emacs.help:110478 Archived-At: Tim Johnson writes: > I grew up on a homestead. We just made > things work. Indeed. I have the gene as well. Make it work, by out working the opposition... > I find the whole concept of lisp (as in > elisp, racket, clojure) associates with the > minimalist (homestead) approach of right and > left parens to be a study in > simplistic beauty. I prefer the Lisp syntax and extra power compared to other languages - e.g., code as data, data as code, almost complete freedom, no explicit types, and many other examples - from a practical point tho the thing I like the most is the integration with Emacs (the quick fix) so you immediately can see the result of your actions. It is the most pleasant way of programming. I have sort of the same in the shell (zsh) but not exactly as the infrastructure is much less developed, you have to reload the code manually (even tho it takes zero time, still annoying compared to the eval of a single defun). Even so, compared to LaTeX and C and such giants with feet of clay, the shell seems like a bunch of thin clouds... > And as for emacs, the help system is awesome, > maybe the best thing. I also use python. > Docstrings rock! Indeed. Good example of infrastructure. I like focusing on the form, making it perfect, and then wait for the data to "catch up"... It always feels like a loss of prestige when you have to Google something like some mere plebeian. To have a uniform interface is great. Only sometimes the docstrings themselves are incomplete - for example, not that seldom, the function comes with arguments that aren't mentioned in the docstring. Here is an example of a bad docstring in several ways: (transpose-sexps ARG) Like M-t but applies to sexps. Does not work on a sexp that point is in the middle of if it is a list or string. -- underground experts united .... http://user.it.uu.se/~embe8573 Emacs Gnus Blogomatic ......... http://user.it.uu.se/~embe8573/blogomatic - so far: 48 Blogomatic articles -