docs: update api.md for createNewStickerSet (#1043)

* fix: createNewStickerSet description error * docs: Update api.md
yagop · Jan 31, 2023 · 6077f9b · 6077f9b
1 parent 41f493b
commit 6077f9b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/api.md b/doc/api.md
@@ -1870,7 +1870,7 @@ You must use exactly one of the fields *png_sticker*, *tgs_sticker*, or *webm_st
 | Param | Type | Description |
 | --- | --- | --- |
 | userId | <code>Number</code> | User identifier of created sticker set owner |
-| name | <code>String</code> | Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g.,   *"animals"*). Can contain only english letters, digits and underscores.  Must begin with a letter, can't contain consecutive underscores and must end in `.` is case insensitive. 1-64 characters. |
+| name | <code>String</code> | Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g.,   *"animals"*). Can contain only english letters, digits and underscores.  Must begin with a letter, can't contain consecutive underscores and must end in `"_by_<bot_username>"`. `<bot_username>` is case insensitive. 1-64 characters. |
 | title | <code>String</code> | Sticker set title, 1-64 characters |
 | pngSticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | Png image with the sticker, must be up to 512 kilobytes in size,  dimensions must not exceed 512px, and either width or height must be exactly 512px. |
 | emojis | <code>String</code> | One or more emoji corresponding to the sticker |

diff --git a/src/telegram.js b/src/telegram.js
@@ -2432,7 +2432,8 @@ class TelegramBot extends EventEmitter {
    *
    * @param  {Number} userId User identifier of created sticker set owner
    * @param  {String} name Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g.,   *"animals"*). Can contain only english letters, digits and underscores.
-   *  Must begin with a letter, can't contain consecutive underscores and must end in `.` is case insensitive. 1-64 characters.
+   *  Must begin with a letter, can't contain consecutive underscores and must end in `"_by_<bot_username>"`. `<bot_username>` is case insensitive. 1-64 characters.
+
    * @param  {String} title Sticker set title, 1-64 characters
    * @param  {String|stream.Stream|Buffer} pngSticker Png image with the sticker, must be up to 512 kilobytes in size,
    *  dimensions must not exceed 512px, and either width or height must be exactly 512px.