From mboxrd@z Thu Jan  1 00:00:00 1970
From: elfring@users.sourceforge.net (SF Markus Elfring)
Date: Mon, 20 Apr 2015 15:21:25 +0200
Subject: [Cocci] documentation improvements
In-Reply-To: <20150420091540.GA7998@pema>
References: <alpine.DEB.2.02.1504191727560.2028@localhost6.localdomain6>
 <5534B7F6.7070208@users.sourceforge.net> <20150420091540.GA7998@pema>
Message-ID: <5534FD55.70401@users.sourceforge.net>
To: cocci@systeme.lip6.fr
List-Id: cocci@systeme.lip6.fr

> However, improving the user documentation is part of
> what I am supposdd to do on Coccinelle dugring this year.

That is an interesting development.


> In particular, if you could let me know which are
> the areas which, according to you, are not so well documented,
> that woudl be helpful.

I see that there are improvement possibilities like the following.
* A bit of spell checking

* How are the chances to pass program parameter descriptions
  to a dedicated Latex macro so that more consistent
  formatting of the option collection can be achieved?

* Better outline around functionality from the semantic
  patch language

* Would additional links be useful?

* Can a tool like "OCamlDoc" also help?

Regards,
Markus