Flake8 docstrings #256
Open
Flake8 docstrings #256
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpmelos
reviewed
Nov 29, 2021
| @@ -338,16 +338,18 @@ def _line_helper(self, line): | |||
|
|
|||
| @property | |||
| def vcf(self): | |||
| """serialize to VCARD as specified in RFC2426, | |||
| """Serialize to VCARD as specified in RFC2426, | |||
There was a problem hiding this comment.
In a lot of places, it seems like we apply the rule that the first line should be empty if the docstirng is multiline, but the linter is not complaining here, nor in the docstring below (in generate_random_uid). Is that expected? Should the first line be empty in multiline docstrings? I'm asking because this change is intentionally made in some places, but not others.
| @@ -363,7 +366,8 @@ def __init__(self, account_id, provider_info, email_address, conn, readonly=True | |||
|
|
|||
| def _fetch_folder_list(self): | |||
| # type: () -> List[Tuple[Tuple[bytes, ...], bytes, str]] | |||
| r""" NOTE: XLIST is deprecated, so we just use LIST. | |||
| r""" | |||
| @@ -424,7 +424,8 @@ def __deduplicate_message_object_creation(self, db_session, raw_messages, accoun | |||
| def add_message_to_thread(self, db_session, message_obj, raw_message): | |||
| """Associate message_obj to the right Thread object, creating a new | |||
| thread if necessary. We rely on Gmail's threading as defined by | |||
| X-GM-THRID instead of our threading algorithm.""" | |||
| X-GM-THRID instead of our threading algorithm. | |||
| """ | |||
There was a problem hiding this comment.
Same question here about the first line in multiline docstrings being empty.
| @@ -1,5 +1,6 @@ | |||
| """Utility for loading SQLAlchemy model classes and friends. Please see | |||
| inbox/models/__init__.py for the explanation of why this is necessary.""" | |||
| inbox/models/__init__.py for the explanation of why this is necessary. | |||
| """ | |||
| @@ -21,7 +23,8 @@ def __init__(self, message, http_code, server_error=None): | |||
| class SearchStoreException(Exception): | |||
| """Raised if there's an error proxying the search request to the provider. | |||
| This is a special EAS case where the Status code for the Store element has | |||
| an error""" | |||
| an error | |||
| """ | |||
| """ Creates new, empty test databases. """ | ||
| """ | ||
| Create new, empty test databases. | ||
| """ |
There was a problem hiding this comment.
This one fits in a single line.
| and that the update is queued in the ActionLog.""" | ||
|
|
||
| and that the update is queued in the ActionLog. | ||
| """ |
There was a problem hiding this comment.
Same question about empty first line here.
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The configuration is copied from another project of ours.