diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
| commit | 3de130c2da3b93a3404f264e92d7b65354de3548 (patch) | |
| tree | 368b1847fffe7af21c5fbc3fa7925212b678e60b /user_guide_src/source/helpers/number_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/number_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/number_helper.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst index 5a3d72b00..2de4457d9 100644 --- a/user_guide_src/source/helpers/number_helper.rst +++ b/user_guide_src/source/helpers/number_helper.rst @@ -29,7 +29,8 @@ The following functions are available: :param mixed $num: Number of bytes :param int $precision: Floating point precision - :returns: string + :returns: Formatted data size string + :rtype: string Formats numbers as bytes, based on size, and adds the appropriate suffix. Examples:: @@ -48,4 +49,4 @@ The following functions are available: echo byte_format(45678, 2); // Returns 44.61 KB .. note:: The text generated by this function is found in the following - language file: `language/<your_lang>/number_lang.php`
\ No newline at end of file + language file: *language/<your_lang>/number_lang.php*
\ No newline at end of file |