Documentation

[dpo]

Just a thought. I wonder if the documentation for the core interface functions could be the contents of the corresponding man page. For example help(usetup) would display the result of man cutest_usetup. Is that possible?

[abelsiqueira]

Since the man pages are in $CUTEST/man/man3, this will be very easy to add to the script. I started to read the Docile and Lexicon documentation, so I'll implement this soon.

[dpo]

Great! Thanks!

[abelsiqueira]

Converting the man page to plain text was a little more troublesome than anticipated, if you know of a better way, please let me know. f1950c8 shows what I managed to do.

[dpo]

I thought it might be possible to set the contents of a docstring to the result of the command man cutest_usetup.

[dpo]

For example at the Julia command line, I can hit ; and do

shell> man cutest_usetup

Could we get help(usetup) to perform the same operation?

[abelsiqueira]

I will check if that's possible, but we need to consider the documentation for the specialized interface too, because they share the name now.

[abelsiqueira]

The best I could reach was

@doc :(run(`man ls`)) foo

But I can't run that. Do you think we should ask in julia-users?

[dpo]

Maybe it's not possible. Perhaps the docstring could just recommend that the user run the shell command man cutest_$(function_name) to learn more.

[abelsiqueira]

That's good

[abelsiqueira]

I implemented your suggestion along with a basic usage and parameter list in f82c0e5.
I will try to grab some info from the man file from python before PRing.

[abelsiqueira]

Implemented by #36