Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unified args and attrs in classes #3404

Merged
merged 74 commits into from Dec 27, 2022
Merged

Unified args and attrs in classes #3404

merged 74 commits into from Dec 27, 2022

Commits on Nov 28, 2022

  1. titles-only toctrees

    @Bibo-Joshi
    Bibo-Joshi committed Nov 28, 2022
    Copy the full SHA
    940a492 View commit details
    Browse the repository at this point in the history

  2. Conversationhandler docfix (#3395)

    @lemontree210 @Bibo-Joshi
    lemontree210 authored and Bibo-Joshi committed Nov 28, 2022
    Copy the full SHA
    cf9b228 View commit details
    Browse the repository at this point in the history

  3. fix(Bot): :attr:->:meth: in seealso where applicable

    @lemontree210 @Bibo-Joshi
    lemontree210 authored and Bibo-Joshi committed Nov 28, 2022
    Copy the full SHA
    c53c721 View commit details
    Browse the repository at this point in the history

Commits on Nov 30, 2022

  1. Add more crossrefs to docstrings (#3398)

    @lemontree210
    lemontree210 committed Nov 30, 2022
    Copy the full SHA
    eb07a2b View commit details
    Browse the repository at this point in the history

Commits on Dec 1, 2022

  1. Clarify docs of the filter argument in MessageHandler (#3403)

    @Viicos
    Viicos committed Dec 1, 2022
    Copy the full SHA
    421518b View commit details
    Browse the repository at this point in the history

Commits on Dec 2, 2022

  1. unify attrs and args in Dice

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    d8d3d31 View commit details
    Browse the repository at this point in the history

  2. unify attrs and args in LoginURL

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    c627e86 View commit details
    Browse the repository at this point in the history

  3. fix(User): "bots"->"bot's" in args

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    c599963 View commit details
    Browse the repository at this point in the history

  4. Update: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    88f0c65 View commit details
    Browse the repository at this point in the history

  5. PollAnswer: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    e61968d View commit details
    Browse the repository at this point in the history

  6. MessageEntity: unify args and attrs 

    it was not done completely in #3314
(`user` attr needed addition)
    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    2980497 View commit details
    Browse the repository at this point in the history

  7. Location: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    b0ce3a4 View commit details
    Browse the repository at this point in the history

  8. CallbackQuery: unify args and attrs 

    not sure this is correct in the attrs, but
I'm not changing it:
data (:obj:`str` | :obj:`object`)
(it's only `str` in args)
    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    2d55ed8 View commit details
    Browse the repository at this point in the history

  9. ChatInviteLink: unify args and attrs 

    * not sure I had to add the note for `invite_link` to args,
but it is there in Telegram API

* Telegram API contains no explicit limit
for `name` arg/attr
    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    717f643 View commit details
    Browse the repository at this point in the history

  10. ChatLocation: unify args and attrs 

    maybe "Can't be a live location" and
limit constants are not needed in attrs,
but it matches Telegram API
    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    0bc70f6 View commit details
    Browse the repository at this point in the history

  11. ChatMember: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 2, 2022
    Copy the full SHA
    268a853 View commit details
    Browse the repository at this point in the history

Commits on Dec 3, 2022

  1. Add a note in the line of #3401

    @Bibo-Joshi
    Bibo-Joshi committed Dec 3, 2022
    Copy the full SHA
    9fd18c7 View commit details
    Browse the repository at this point in the history

  2. ChatMemberUpdated: add to invite_link attr

    @lemontree210
    lemontree210 committed Dec 3, 2022
    Copy the full SHA
    fddaf7f View commit details
    Browse the repository at this point in the history

  3. File: unify args and attrs 

    `file_size` in attrs had wrong type too
    @lemontree210
    lemontree210 committed Dec 3, 2022
    Copy the full SHA
    58679f7 View commit details
    Browse the repository at this point in the history

  4. InlineKeyboardButton: unify args and attrs, fix bold text 

    I didn't include Tip and ..seealso from `callback_data`
argument as I assume it is not put into attrs on purpose
    @lemontree210
    lemontree210 committed Dec 3, 2022
    Copy the full SHA
    0e24a4b View commit details
    Browse the repository at this point in the history

Commits on Dec 5, 2022

  1. minor(InlineKeyboardButton) add ref to class 

    it's not really needed, but at least monospace
font was in place, I think, so why not put a reference
    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    f4575af View commit details
    Browse the repository at this point in the history

  2. minor(MenuButtonWebApp) add ref to class Bot 

    from reading the docstr it isn't clear that it's
a method of Bot
    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    83c0a4c View commit details
    Browse the repository at this point in the history

  3. unify args and attrs in UserProfilePhotos

    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    df3e984 View commit details
    Browse the repository at this point in the history

  4. unify args and attrs in StickerSet

    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    d93ac70 View commit details
    Browse the repository at this point in the history

  5. unify args and attrs in MaskPosition

    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    cce57ae View commit details
    Browse the repository at this point in the history

  6. unify args and attrs in Sticker

    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    d796bf4 View commit details
    Browse the repository at this point in the history

  7. unify args and attrs in BotCommand

    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    94bd384 View commit details
    Browse the repository at this point in the history

  8. unify args and attrs in Game 

    text_entities was not marked with 'Optional.' in attrs.
Leaving the phrase that is not there in Telegram API:
"This list is empty if the message does not contain text entities."
    @lemontree210
    lemontree210 committed Dec 5, 2022
    Copy the full SHA
    d4d3600 View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2022

  1. Animation: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 6, 2022
    Copy the full SHA
    8b81e1f View commit details
    Browse the repository at this point in the history

  2. Audio: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 6, 2022
    Copy the full SHA
    9828dab View commit details
    Browse the repository at this point in the history

Commits on Dec 7, 2022

  1. update furo

    @harshil21
    harshil21 committed Dec 7, 2022
    Copy the full SHA
    b2c3606 View commit details
    Browse the repository at this point in the history

  2. fix(ChatPhoto) rm "unique" from docstring of big/small_file_id attrs

    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    c11ba1e View commit details
    Browse the repository at this point in the history

  3. 'Document': unify args and attrs 

    including fix of lacking "Optional" in `.file_name`
    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    c893aa5 View commit details
    Browse the repository at this point in the history

  4. 'Force Reply': unify args and attrs 

    I decided to include the explanation for `selective`
as well, but removed the phrase "Use this parameter"
as it makes no sense in attrs
    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    d8f9f28 View commit details
    Browse the repository at this point in the history

  5. 'InputMedia': unify args and attrs 

    I decided to add substitution strings to
`parse_mode` and `caption_entities`,
but did not duplicate `media` arg in attrs
    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    00c4087 View commit details
    Browse the repository at this point in the history

  6. minor: remove trailing colon in versionchanged 

    Sphinx adds a colon automatically
    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    7511938 View commit details
    Browse the repository at this point in the history

  7. PhotoSize: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    c92d818 View commit details
    Browse the repository at this point in the history

  8. ReplyKeyboardMarkup: unify args and attrs, fix type of .keyboard … 

    …attr
    @lemontree210
    lemontree210 committed Dec 7, 2022
    Copy the full SHA
    7b15311 View commit details
    Browse the repository at this point in the history

Commits on Dec 8, 2022

  1. ReplyKeyboardRemove: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    cc93abf View commit details
    Browse the repository at this point in the history

  2. InputMedia...: unify args and attrs + fix InputMediaAudio.duration 

    * not changing docstr of `media` attr
* move `thumb` up in attrs where applicable and
apply |thumbdocstringbase| substitution (only the base
should suffice as no directions are needed on how to
send the file)
* add "optional" to `duration` arg and attr
of InputMediaAudio
    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    3e0f791 View commit details
    Browse the repository at this point in the history

  3. minor(InlineKeyboardButton): add bold in callback_game attr

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    eabf480 View commit details
    Browse the repository at this point in the history

  4. KeyboardButton: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    821b33d View commit details
    Browse the repository at this point in the history

  5. fix(KeyboardButtonPollType): add Args: section 

    re-formulate attrs section without "is passed" phrases
    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    110c030 View commit details
    Browse the repository at this point in the history

  6. Venue: unify args and attrs 

    I see no harm in adding links/examples for types
    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    8789bea View commit details
    Browse the repository at this point in the history

  7. Video: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    de1e9e6 View commit details
    Browse the repository at this point in the history

  8. VideoNote: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    864d9da View commit details
    Browse the repository at this point in the history

  9. Voice: unify args and attrs + fix duration 

    duration arg is not optional in `Voice`
    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    2890c0b View commit details
    Browse the repository at this point in the history

  10. ChosenInlineResult: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    2fe6d36 View commit details
    Browse the repository at this point in the history

  11. InlineQuery: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    b294166 View commit details
    Browse the repository at this point in the history

  12. InlineQueryResultCachedAudio: fix typo in attrs

    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    be96d7a View commit details
    Browse the repository at this point in the history

  13. InlineQueryResultCachedGif: fix typo in args 

    `caption` was doubled in `title` arg
    @lemontree210
    lemontree210 committed Dec 8, 2022
    Copy the full SHA
    5a8468b View commit details
    Browse the repository at this point in the history

Commits on Dec 9, 2022

  1. InlineQueryResult...[...Gif/...Mpeg4Gif]: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    5456f22 View commit details
    Browse the repository at this point in the history

  2. InlineQueryResultLocation: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    66a4d68 View commit details
    Browse the repository at this point in the history

  3. InlineQueryResultVenue: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    756994f View commit details
    Browse the repository at this point in the history

  4. InlineQueryResultVideo: unify args and attrs 

    in attrs, all "optional" marks were done as in args, fix that
    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    0c0f200 View commit details
    Browse the repository at this point in the history

  5. InputTextMessageContent: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    2bb0104 View commit details
    Browse the repository at this point in the history

  6. InputLocationMessageContent: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    f56313c View commit details
    Browse the repository at this point in the history

  7. InputVenueMessageContent: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    0a7642f View commit details
    Browse the repository at this point in the history

  8. InputInvoiceMessageContent: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    fb08193 View commit details
    Browse the repository at this point in the history

  9. Invoice: unify args and attrs 

    I think the 2nd part of docstring for `start_parameter`
 can be useful to understand this attr, despite
 the phrase addressing the generation of the Invoice
    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    d08fb9a View commit details
    Browse the repository at this point in the history

  10. LabeledPrice: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    0775af5 View commit details
    Browse the repository at this point in the history

  11. PreCheckoutQuery: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    c5d3756 View commit details
    Browse the repository at this point in the history

  12. SuccessfulPayment: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    0287c35 View commit details
    Browse the repository at this point in the history

  13. PassportFile: unify args and attrs

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    423ee44 View commit details
    Browse the repository at this point in the history

  14. add Args sections to PersonalDetails, ResidentialAddress, `IdDo… 

    …cumentData`
    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    16bbb30 View commit details
    Browse the repository at this point in the history

  15. add Args sections to SecureData, SecureValue

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    a881c48 View commit details
    Browse the repository at this point in the history

  16. add message arg to PassportElementError

    @lemontree210
    lemontree210 committed Dec 9, 2022
    Copy the full SHA
    dee43f0 View commit details
    Browse the repository at this point in the history

Commits on Dec 14, 2022

  1. Merge remote-tracking branch 'origin/doc-fixes' into unified-args-and… 

    …-attrs-3109
    @lemontree210
    lemontree210 committed Dec 14, 2022
    Copy the full SHA
    367a86c View commit details
    Browse the repository at this point in the history

Commits on Dec 16, 2022

  1. merge doc-fixes (resolve conflicts)

    @lemontree210
    lemontree210 committed Dec 16, 2022
    Copy the full SHA
    be44d40 View commit details
    Browse the repository at this point in the history

Commits on Dec 18, 2022

  1. Merge remote-tracking branch 'origin/doc-fixes' into unified-args-and… 

    …-attrs-3109
    @lemontree210
    lemontree210 committed Dec 18, 2022
    Copy the full SHA
    4a9cd23 View commit details
    Browse the repository at this point in the history

Commits on Dec 21, 2022

  1. Merge remote-tracking branch 'origin/doc-fixes' into unified-args-and… 

    …-attrs-3109
    @lemontree210
    lemontree210 committed Dec 21, 2022
    Copy the full SHA
    c078486 View commit details
    Browse the repository at this point in the history

  2. Merge remote-tracking branch 'origin/doc-fixes' into unified-args-and… 

    …-attrs-3109
    @lemontree210
    lemontree210 committed Dec 21, 2022
    Copy the full SHA
    719d3bb View commit details
    Browse the repository at this point in the history

Commits on Dec 23, 2022

  1. ChatInviteLink: remove explanatory phrase for invite_link arg 

    It makes sense in attrs but not in args
    @lemontree210
    lemontree210 committed Dec 23, 2022
    Copy the full SHA
    57eb906 View commit details
    Browse the repository at this point in the history

Commits on Dec 26, 2022

  1. Merge remote-tracking branch 'origin/doc-fixes' into unified-args-and… 

    …-attrs-3109
    @lemontree210
    lemontree210 committed Dec 26, 2022
    Copy the full SHA
    e7da6ab View commit details
    Browse the repository at this point in the history