Yet more function documentation

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@571 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2007-07-14 00:29:25 +00:00
parent 6467ff9909
commit 689def7325
53 changed files with 174 additions and 8 deletions
+24
View File
@@ -0,0 +1,24 @@
Function: english_number
--Usage--
> english_number(number)
> english_number_a(number)
> english_number_multiple(number)
> english_number_ordinal(number)
Convert a number to English.
These four functions all behave slightly differently:
! Function function(1) function(2) function(3)
| @english_number@ @"one"@ @"two"@ @"three"@
| @english_number_a@ @"a"@ @"two"@ @"three"@
| @english_number_multiple@ @""@ @"two"@ @"three"@
| @english_number_ordinal@ @"first"@ @"second"@ @"third"@
If the input is a keyword parameter value, it leaves a hint tag for [[fun:process_english_hints]], to indicate whether the following word should be plural or singular.
--Parameters--
! Parameter Type Description
| @input@ [[type:int]] Number to convert
--Examples--
> english_number(1) == "one"