From fca1fcc78971dd01f1987d911d4abe3c7a99e2e8 Mon Sep 17 00:00:00 2001 From: levlam Date: Sat, 27 Jul 2019 17:53:07 +0300 Subject: [PATCH] Documentation improvements. GitOrigin-RevId: a0cbc3baa32f3f5e2b2b73814daf060c2484df3d --- CHANGELOG.md | 12 ++++++------ td/generate/scheme/td_api.tl | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b8c5c15..12c9e237 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -65,7 +65,7 @@ Changes in 1.4.0: - Added the separate notification scope `notificationSettingsScopeChannelChats` for channel chats. * Added support for pinned notifications in basic groups and Saved Messages: - Added the field `pinned_message_id` to the class `chat`. - - Removed the field `pinned_message_id` from the class `supergroupFullInfo` in favor of `Chat.pinned_message_id`. + - Removed the field `pinned_message_id` from the class `supergroupFullInfo` in favor of `chat.pinned_message_id`. - Added the update `updateChatPinnedMessage`. - The right `can_pin_messages` is now applicable to both basic groups and supergroups. - Replaced the method `pinSupergroupMessage` with `pinChatMessage` which can be used for any chat type. @@ -101,7 +101,7 @@ Changes in 1.4.0: `pageBlockTableCell`. - Added new block types `pageBlockKicker`, `pageBlockRelatedArticles`, `pageBlockTable`, `pageBlockDetails` and `pageBlockMap`. - - Added the flag `is_rtl` to `webPageInstantView` object. + - Added the flag `is_rtl` to the class `webPageInstantView`. - Renamed the field `caption` in classes `pageBlockBlockQuote` and `pageBlockPullQuote` to `credit`. - Dimensions in `pageBlockEmbedded` can now be unknown. - Added the field `url` to `pageBlockPhoto` which contains a URL that needs to be opened when the photo is clicked. @@ -139,10 +139,10 @@ Changes in 1.4.0: * Added the update `updateChatOnlineMemberCount` which is automatically sent for open group chats if the number of online members in a group changes. * Added support for custom language packs downloaded from the server: - - Added the fields `base_language_pack_id`` to the `languagePackInfo` object. Strings from the base language pack + - Added the fields `base_language_pack_id`` to the class `languagePackInfo`. Strings from the base language pack must be used for untranslated keys from the chosen language pack. - Added the fields `plural_code`, `is_official`, `is_rtl`, `is_beta`, `is_installed`, `total_string_count`, - `translated_string_count`, `translation_url` to the `languagePackInfo` object. + `translated_string_count`, `translation_url` to the class `languagePackInfo`. - Added the method `addCustomServerLanguagePack` which adds a custom server language pack to the list of installed language packs. - Added the method `getLanguagePackInfo` which can be used for handling `https://t.me/setlanguage/...` links. @@ -210,7 +210,7 @@ Changes in 1.4.0: It can now be used to dynamically discover available methods. * Added the ability to delete incoming messages in private chats and revoke messages without a time limit: - Added the parameter `revoke` to the method `deleteChatHistory`; use it to delete chat history for all chat members. - - Added the fields `can_be_deleted_only_for_self` and `can_be_deleted_for_all_users` to `Chat` object + - Added the fields `can_be_deleted_only_for_self` and `can_be_deleted_for_all_users` to the class `chat` which can be used to determine for whom the chat can be deleted through the `deleteChatHistory` method. - The fields `Message.can_be_deleted_only_for_self` and `Message.can_be_deleted_for_all_users` can still be used to determine for whom the message can be deleted through the `deleteMessages` method. @@ -419,7 +419,7 @@ Changes in 1.2.0: * Added new message content type `messageWebsiteConnected`. * Added new text entity types `textEntityTypeCashtag` and `textEntityTypePhoneNumber`. * Added new update `updateUnreadMessageCount`, enabled when message database is used. -* Method `joinChatByInviteLink` now returns the joined `Chat`. +* Method `joinChatByInviteLink` now returns the joined `chat`. * Method `getWebPagePreview` now accepts `formattedText` instead of plain `string`. * Added field `phone_number` to `authenticationCodeInfo`, which contains a phone number that is being authenticated. * Added field `is_secret` to `messageAnimation`, `messagePhoto`, `messageVideo` and `messageVideoNote` classes, diff --git a/td/generate/scheme/td_api.tl b/td/generate/scheme/td_api.tl index 70b1dea5..d7e2bca8 100644 --- a/td/generate/scheme/td_api.tl +++ b/td/generate/scheme/td_api.tl @@ -173,7 +173,7 @@ inputFileGenerated original_path:string conversion:string expected_size:int32 = //@description Photo description @type Thumbnail type (see https://core.telegram.org/constructor/photoSize) @photo Information about the photo file @width Photo width @height Photo height photoSize type:string photo:file width:int32 height:int32 = PhotoSize; -//@description A very poor quality and low resolution image thumbnail @width Thumbnail width, usually doesn't exceed 40 @height Thumbnail height, usually doesn't exceed 40 @data The thumbnail +//@description A very poor quality and low resolution image thumbnail @width Thumbnail width, usually doesn't exceed 40 @height Thumbnail height, usually doesn't exceed 40 @data The thumbnail in JPEG format minithumbnail width:int32 height:int32 data:bytes = Minithumbnail; @@ -606,7 +606,7 @@ chatTypeSecret secret_chat_id:int32 user_id:int32 = ChatType; //@type Type of the chat //@title Chat title //@photo Chat photo; may be null -//@permissions Actions that non-administrator chat member are allowed to take in the chat +//@permissions Actions that non-administrator chat members are allowed to take in the chat //@last_message Last message in the chat; may be null //@order Descending parameter by which chats are sorted in the main chat list. If the order number of two chats is the same, they must be sorted in descending order by ID. If 0, the position of the chat in the list is undetermined //@is_pinned True, if the chat is pinned