Register forum user name Search FAQ

Gammon Forum

Notice: Any messages purporting to come from this site telling you that your password has expired, or that you need to verify your details, confirm your email, resolve issues, making threats, or asking for money, are spam. We do not email users with any such messages. If you have lost your password you can obtain a new one by using the password reset link.

Due to spam on this forum, all posts now need moderator approval.

 Entire forum ➜ MUSHclient ➜ General ➜ Improvements to help and documentation

Improvements to help and documentation

It is now over 60 days since the last post. This thread is closed.     Refresh page


Posted by Nick Gammon   Australia  (23,133 posts)  Bio   Forum Administrator
Date Wed 25 Apr 2007 03:40 AM (UTC)

Amended on Wed 25 Apr 2007 03:42 AM (UTC) by Nick Gammon

Message
Release 4.06 has a major revamp of the Lua documentation. I was starting to find that looking up a particular function in the help was a bit tedious, as many functions were grouped together in the same help page.

After a considerable amount of copying and pasting, these Lua help pages have now been broken down into individual pages, one per function.

The online documentation at this site reflects this change, to see the general idea, see the string.find help topic:

http://www.gammon.com.au/scripts/doc.php?lua=string.find

Or check out this page which shows how the general topic of the string library now basically just lists the individual functions as hyperlinks, rather than trying to explain each one on a single page:

http://www.gammon.com.au/scripts/doc.php?general=lua_string


Now that each function is in its own page, it should be a lot easier to implement function-name completion, and getting help on individual functions, directly from within the notepad or command window.

- Nick Gammon

www.gammon.com.au, www.mushclient.com
Top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.


4,285 views.

It is now over 60 days since the last post. This thread is closed.     Refresh page

Go to topic:           Search the forum


[Go to top] top

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.