Difference between revisions of "User:Kebap"

From Mudlet
Jump to navigation Jump to search
(move to Area 51)
Line 7: Line 7:
  
 
* [[User:Kebap/documentation-in-wiki]] - currently on hold
 
* [[User:Kebap/documentation-in-wiki]] - currently on hold
 +
** Standardize layout of [[Manual:Lua_Functions]] in [[Area 51]]
  
 
* [[User:Kebap/translation infrastructure|Establish translation-infrastructure for Mudlet universe]]
 
* [[User:Kebap/translation infrastructure|Establish translation-infrastructure for Mudlet universe]]
Line 45: Line 46:
 
= Examples for formatting =
 
= Examples for formatting =
  
API documentation of a function as used in [[Manual:Lua_functions]]:
+
== API documentation ==
  
==functionName==
+
Examples and description moved to [[Area 51]] plus template linked from there
;returnValue = 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
 
 
 
See also:
 
[[Manual:Lua_Functions#copy|copy]],
 
[[Manual:Lua_Functions#paste|paste]]
 
 
 
{{note}} This is an important information
 
 
 
{{MudletVersion|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)
 
 
 
;Returns
 
* whatever the function returns.
 
 
 
;Example
 
<syntaxhighlight lang="lua">
 
--a small example snippet of the function in action
 
--the comments up top should introduce it/explain what the snippet does
 
functionName("arg1", "arg2")
 
</syntaxhighlight>
 
  
 
== Standardized error messages in code ==
 
== Standardized error messages in code ==

Revision as of 07:29, 21 June 2021

About me

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

Projects

  • 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 formatting

API documentation

Examples and description moved to Area 51 plus template linked from there

Standardized error messages in code

Old style, not very informative:

    if (!lua_isnumber(L, 1)) {
        lua_pushstring(L, "createMapLabel: wrong argument type");
        return lua_error(L);
    }
    int area = lua_isnumber(L, 1);

New style with additional information:

    if (!lua_isnumber(L, 1)) {
        lua_pushfstring(L,
                "createMapLabel: bad argument #1 type (areaID as number expected, got %s!)",
                luaL_typename(L, 1));
        return lua_error(L);
    }
    int area = lua_tointeger(L, 1);