From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Rocky Bernstein Newsgroups: gmane.emacs.devel Subject: Realgud documentation: (Was: realgud now in elpa) Date: Tue, 2 Aug 2016 19:42:49 -0400 Message-ID: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=94eb2c19228849dec205391f468d X-Trace: blaine.gmane.org 1470181391 2183 195.159.176.226 (2 Aug 2016 23:43:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 2 Aug 2016 23:43:11 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Aug 03 01:43:07 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bUjKy-0008HL-BQ for ged-emacs-devel@m.gmane.org; Wed, 03 Aug 2016 01:43:04 +0200 Original-Received: from localhost ([::1]:59398 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bUjKu-0003fh-S6 for ged-emacs-devel@m.gmane.org; Tue, 02 Aug 2016 19:43:00 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:39428) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bUjKo-0003fL-4P for emacs-devel@gnu.org; Tue, 02 Aug 2016 19:42:55 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bUjKl-00021e-PL for emacs-devel@gnu.org; Tue, 02 Aug 2016 19:42:53 -0400 Original-Received: from mail-ua0-x22e.google.com ([2607:f8b0:400c:c08::22e]:34083) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bUjKl-00021X-IO for emacs-devel@gnu.org; Tue, 02 Aug 2016 19:42:51 -0400 Original-Received: by mail-ua0-x22e.google.com with SMTP id 35so140883135uap.1 for ; Tue, 02 Aug 2016 16:42:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:sender:from:date:message-id:subject:to; bh=2kYWF5YBgRsBIcPbg3cjcKoXduluo2yC0ekEO6ZXVQY=; b=ajUC5riRr9CTqRllTcOniYY3BJKShy4RRrtMrgbOBWFfDID2byO67tAa9AAzFJW24i AuazCvycoM6V4GH1U8TauAIYqhYSVF63nv84Sf4eCUwffMYgL6U9O/pkODKkbR5zX3W9 JwxfL9qV8y28+7DNK5+oahbTi3yJXfSUxr6o2YOcogXUzP+r/TZ/p3lOYoHYhLTyN7k/ 7P1UgQTqZEDb0DQzxqkYg+tc0YXqWXBUuu835xv0aYx4eN5xkM0aZscGLkktSfXYhtUL QSTHxiYETr9L+GD+Dl04tl3rcZ/Vt/cVtTMF8TsUfr+xrXPsOY/1QKa7tLYL3pnwHWpg 3yew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:sender:from:date:message-id:subject :to; bh=2kYWF5YBgRsBIcPbg3cjcKoXduluo2yC0ekEO6ZXVQY=; b=gEnaaG/iF0k/x0y203XXL8sSFoFh3dSmhTOOuWRTzPWPu7MIOoyMM58eQHn+6GIWEg oOnlo8CvRVTIF4OscAdoaYaMTBsVcUQJn5liawJPWMgjr2x4ZEzYa4qCPrlD5pJ6vAi4 fQg1fu6yykQVIbhpq6UPVd44AZk08JyRBunuxmL/fnlslnMvadN1yMnTvvrOLU9KsBya 82VcWT/HJBVQc0ZS/mWXk1OCzbRkCaoPEmc35VOwAHPl52blnXg4NtZY1seEFJUzJVAK lMusrVD4GEgG8ivCHQApiM/mdR2X/bkzxycNKsbZ58JtIyf2wCPq/hKFHT7X57JjEl38 IS5w== X-Gm-Message-State: AEkooutiSU0xfvUDYOGB31PizNoCBvLjZY7Fg2/aTUymPz7XaOPI+eZKgy5kfOyFPF0IsyMMq0JfU1vbiNET2Q== X-Received: by 10.176.83.98 with SMTP id y31mr3446174uay.88.1470181369566; Tue, 02 Aug 2016 16:42:49 -0700 (PDT) Original-Received: by 10.103.148.137 with HTTP; Tue, 2 Aug 2016 16:42:49 -0700 (PDT) X-Google-Sender-Auth: 0VvBsIUSPwN8kZA9wjl_heNSE2k X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:400c:c08::22e 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:206378 Archived-At: --94eb2c19228849dec205391f468d Content-Type: text/plain; charset=UTF-8 T.V Raman reports: > > s/melpa/elpa/ and for the record, most packages installed via the > > package manager be it elpa or melpa come with almost no documentation. and rms advises: *> It is important to write documentation for them. How about asking* > * the authors of some packages to write manuals for them?* I totally agree. A good deal of the software I write in fact has extensive documentation. See for example: https://www.gnu.org/software/libcdio/libcdio.html, http://bashdb.sourceforge.net/bashdb.html, http://bashdb.sourceforge.net/ruby-debug.html for texinfo-style documentation and http://python2-trepan.readthedocs.io/en/latest/ for non-texinfo style. But in this particular case, for various reasons, it will probably be a while before I undertake to write any sort of comprehensive documentation in texinfo format. However, I invite others to start with what's there in the github wiki and the README.md that is provided in elpa, and turn that into texinfo. And I'll be happy to include that in the installation. Don't know this particular package that well? Well, the best way to learn it is to start documenting what's there as you go along. There are also plenty of docstrings that describe functions. And if you have a question about something, just contact me and I will be happy to assist or review documentation. In sum, turn your passion for good documentation into something tangible. --94eb2c19228849dec205391f468d Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable 
T.V Raman reports: 

> > s/melpa/elpa/  a=
nd for the record, most packages installed via the
> > package manager be it elpa or melpa come with almost no documenta=
tion.

and rms advises: 

> It is important to write do=
cumentation for them.  How about asking
> the authors of some packages to write manuals for them?


=

I totally agree. A good deal of the software I write in fact=
 has extensive documentation. See for example: 
https://www.gnu.org=
/software/libcdio/libcdio.html, http://bashdb.sourceforge.net/bashdb.html, 
http:/=
/bashdb.sourceforge.net/ruby-debug.html for texinfo-style documentation=
 and 
http:/=
/python2-trepan.readthedocs.io/en/latest/ 
for non-texinfo style. 
But in this particular case, for various reasons, it will =
probably be a while before I undertake to write any sort of 
comprehensi=
ve documentation in texinfo format.

However, I invite oth=
ers to start with what's there in the github wiki and the README.md that is provided in el=
pa, 
and turn that into texinfo. And I'll be happy to include that i=
n the installation. 

Don't know this particular package that wel=
l? Well, the best way to learn it is to start documenting what's there =
as 
you go along. 
There are also plenty of docstrings tha=
t describe functions. And if you have a question about something, 
just =
contact me and I will be happy to assist or review documentation.

In sum, turn your passion for good documentation into something ta=
ngible.
--94eb2c19228849dec205391f468d--