Multi-line docstring closing quotes should be on a separate line FLK-D209
Documentation
Minor
3 years ago
—
3 years old
Multi-line docstring closing quotes should be on a separate line
150
151
152def end(update: Update, _: CallbackContext) -> int:
153 """Returns `ConversationHandler.END`, which tells the154 ConversationHandler that the conversation is over"""
155 query = update.callback_query
156 query.answer() Multi-line docstring closing quotes should be on a separate line
33def extract_status_change(
34 chat_member_update: ChatMemberUpdated,
35) -> Optional[Tuple[bool, bool]]:
36 """Takes a ChatMemberUpdated instance and extracts whether the 'old_chat_member' was a member 37 of the chat and whether the 'new_chat_member' is a member of the chat. Returns None, if
38 the status didn't change."""
39 status_change = chat_member_update.difference().get("status")
Description
Not Preferred:
def foo():
"""This is an example docstring.
To show how to write multi-line docstring."""
Preferred:
def foo():
"""
This is an example docstring.
To show how to write multi-line docstring.
"""