[NeoStats-Devel] Module API change warning

"M" <[email protected]>
Newsgroups gmane.comp.neostats.devel
Message-ID <[email protected]>
I have made a change locally to the core command processor help system which
requires a change to all modules. Unfortunately, SVN is not responding again
so I am unable to commit this update at the moment.

The change reduces the overhead of the help system by removing the
requirement to provide both a one line and detailed help set for each
command. The new system treats the first line of the help text as the text
for the one line display. 

E.g. 

const char ns_help_level[] = "Permission level";

const char *ns_help_level[] = {
	"Syntax: \2LEVEL [nick]\2",
	"",
...

Becomes:

const char *ns_help_level[] = {
	"Permission level",
	"Syntax: \2LEVEL [nick]\2",
	"",
...

In the short term, this will mean there will be some superfluous help text
where help text is repeated in a '/msg bot help cmd' response until I have
cleaned it all up but there is a long term improvement in a simplified
system for modules and simpler maintainance of help text.

I am also looking at making the help text more veratile so that instead of
printing "Syntax error, /msg bot help cmd for help", we can provide the
syntax part of the help as part of the error message. This will rely on
specific formatting of the help text but if all help follows that of the
majority of help within NeoStats, we almost have such a format anyway. It is
not guaranteed to happen but if anyone has any comments on such a system,
feel free to make them heard.

Mark.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.