From Mudlet
Revision as of 18:19, 15 July 2019 by Kebap (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

About me

Mudlet user and script developer, hailing from MorgenGrauen (German).


  • Enable Discord group "Testers" to (de-)register themselves via Discord reactions done! :)
  • Learn how to make small PR like above with Smart Git instead of github web interface done! :)
Me with a few buddies
  • Improve Mudlet documentation, which is not interesting for Mudlet users, but only for (some) developers.
    • Including definitions on internal functions,
    • discussions and decisions on coding style conventions,
    • standard procedures like Release Checklist, update lua function list for autocompletion,
    • This is done by adding Categories like "Mudlet Developer Manual" or "Mudlet Admin Manual"
    • etc.
  • Look into improving a11y (accessibility) of Mudlet client and website, etc.

Examples for Wiki formatting


functionName(arg1, arg2, [optionalArg3])
What the function does. In this case, it is just a non-existing function with the only purpose to show, how to write documentation for functions
Returns whatever the function returns.

See also: paste, paste

Note Note: Available since Mudlet 3.5

  • arg1:
What arg1 is/does. Passed as a string.
  • arg2:
What arg2 is/does. Passed as a string.
  • optionalArg3
(optional) The name needn't be telling. Relevant is to mark optional arguments at the start of this line (with text "optional" in brackets) and in the function definition line (with [these] brackets)
--a small example snippet of the function in action
--the comments up top should introduce it/explain what the snippet does
functionName("arg1", "arg2")