Difference between revisions of "User:Kebap"

From Mudlet
Jump to navigation Jump to search
Line 23: Line 23:
 
* Create PR to clean up texts in source - see [https://github.com/Mudlet/Mudlet/issues/1801 github issue 1801]  
 
* Create PR to clean up texts in source - see [https://github.com/Mudlet/Mudlet/issues/1801 github issue 1801]  
 
* Learn how to make small PR like above with Smart Git instead of github web interface
 
* Learn how to make small PR like above with Smart Git instead of github web interface
 +
* 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]], etc.
  
 
= Examples for Wiki formatting =
 
= Examples for Wiki formatting =

Revision as of 17:44, 7 October 2018

About me

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

Projects

Examples for Wiki formatting

functionName

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

Parameters
  • 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)
Example
--a small example snippet of the function in action
--the comments up top should introduce it/explain what the snippet does
functionName("arg1", "arg2")