Area 51/Template - Revision history

Kebap: /* See also */ add () brackets to the displayed name

2023-04-02T01:25:54Z

See also: add () brackets to the displayed name

Atari2600tim: /* Contents of a documentation entry */

2022-11-18T18:58:02Z

Contents of a documentation entry

Kebap: add hint for PR #

2021-11-21T19:48:00Z

add hint for PR #

Vadi: Improve error handling in template not to spam main widow

2021-09-24T06:27:11Z

Improve error handling in template not to spam main widow

Vadi: Added example of error handling

2021-09-21T17:52:37Z

Added example of error handling

Kebap: /* functionName */ +link to the pending PR

2021-09-20T09:24:20Z

functionName: +link to the pending PR

Kebap: /* Contents of a documentation entry */ same change of order

2021-09-20T09:10:14Z

Contents of a documentation entry: same change of order

Kebap: /* functionName */ move "version" and "notes" below "see also"

2021-09-20T09:09:40Z

functionName: move "version" and "notes" below "see also"

Kebap: /* functionName */ layout

2021-06-21T07:31:03Z

functionName: layout

Kebap: renamed pages

2021-06-11T11:41:24Z

renamed pages

← Older revision		Revision as of 01:25, 2 April 2023
Line 47:		Line 47:


−	;See also: [[Manual:Lua_Functions#copy\|copy]], [[Manual:Lua_Functions#paste\|paste]]	+	;See also: [[Manual:Lua_Functions#copy\|copy()]], [[Manual:Lua_Functions#paste\|paste()]]

	-- List a few related functions, so users can cyber around.		-- List a few related functions, so users can cyber around.

@@ Line 13: / Line 13: @@
 == Contents of a documentation entry ==
-In the past, we did not always honor the same order. It is important to unify so reader's expectations are met and inportant information is found quickly.
+In the past, we did not always honor the same order. It is important to unify so reader's expectations are met and important information is found quickly.
 The following example uses this order of information:

← Older revision		Revision as of 19:48, 21 November 2021
Line 28:		Line 28:

	==functionName==		==functionName==
		+
		+	The headline will be the function name. That is the only part of the headline that will be transferred to main documentation. However during Area 51 stay, please also add the number of the pull request where it came from, plus the PR's current status (open, merged (to development versions), closed (i.e. not merged), etc.)
		+
	; returnValue = functionName(mandatoryParameter, [optionalParameter])		; returnValue = functionName(mandatoryParameter, [optionalParameter])

@@ Line 96: / Line 96: @@
 local ok, err = function()
 if not ok then
-   cecho(f"\n<red>Error: unable to do function because {err}\n")
+   debugc(f"Error: unable to do <particular thing> because {err}\n")
    return
 end
 </syntaxhighlight>

@@ Line 81: / Line 81: @@
 ;Example
 <syntaxhighlight lang="lua">
--- A comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
+-- a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
--- The examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
+-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
--- Comments up top should introduce / explain what it does
+-- comments up top should introduce / explain what it does
 local something = function(exampleValue)
 if something then
-   -- Do something with something (assuming there is a meaningful return value)
+   -- do something with something (assuming there is a meaningful return value)
 end
--- Maybe another example for the optional second case
+-- maybe another example for the optional second case
 local somethingElse = function(exampleValue, anotherValue)
 </syntaxhighlight>
 ; Additional development notes

← Older revision		Revision as of 09:24, 20 September 2021
Line 56:		Line 56:

	-- The version when the functionality is to be introduced should be given (if already known) using this template (assuming a major.minor version number - though a major.minor.patch format may be possible)		-- The version when the functionality is to be introduced should be given (if already known) using this template (assuming a major.minor version number - though a major.minor.patch format may be possible)
		+	-- If the code has not been merged yet when documentation begins, please link to the pending PR instead for future reference.

@@ Line 19: / Line 19: @@
 # function signature
 # description
 # mudlet version
 # note
 # parameters
 # returns

@@ Line 44: / Line 44: @@
-{{MudletVersion|4.11}}
+;See also: [[Manual:Lua_Functions#copy|copy]], [[Manual:Lua_Functions#paste|paste]]
--- The version when the functionality is to be introduced should be given (if already known) using this template (assuming a major.minor version number - though a major.minor.patch format may be possible)
+-- List a few related functions, so users can cyber around.
-{{note}} This is an important information
+-- Keep the list curated and don't add every single possible function. Maybe link to one central function hub which itself links to all other variants. Mix existing and new, closely and more loosely related functions. For example, creation / editing / deletion of same items, but only creation of other items (which itself link to their editing & deleting variants)
-;See also: [[Manual:Lua_Functions#copy|copy]], [[Manual:Lua_Functions#paste|paste]]
+-- The version when the functionality is to be introduced should be given (if already known) using this template (assuming a major.minor version number - though a major.minor.patch format may be possible)
--- Make sure to mark the internal links without space characters and with no brackets in the end, whereas the displayed name (after the | sign) should indeed end in () brackets
+{{note}} This is an important information
--- Keep the list curated and don't add every single possible function. Maybe link to one central function hub which itself links to all other variants. Mix existing and new, closely and more loosely related functions. For example, creation / editing / deletion of same items, but only creation of other items (which itself link to their editing & deleting variants)
+-- You may add several notes if necessary, but please take care not to mark everything as important

← Older revision		Revision as of 07:31, 21 June 2021
Line 54:		Line 54:


−	~~'''~~See also~~'''~~:	+	;See also: [[Manual:Lua_Functions#copy\|copy]], [[Manual:Lua_Functions#paste\|paste]]
−	[[Manual:Lua_Functions#copy\|copy]],
−	[[Manual:Lua_Functions#paste\|paste]]

	-- List a few related functions, so users can cyber around.		-- List a few related functions, so users can cyber around.

@@ Line 7: / Line 7: @@
 Remember to generally strip out each comment line before publishing a new documentation!
-You are encouraged to use the [[Area_51_documentation]] page to prepare documentation for not-yet-published functionality.
+You are encouraged to use the [[Area_51]] documentation page to prepare documentation for not-yet-published functionality.
-<< Back to [[Area_51_documentation]]
+<< Back to [[Area_51]]
 == Contents of a documentation entry ==