Title: check-docstring-first false positive on attribute docstrings · Issue #159 · pre-commit/pre-commit-hooks · GitHub
Open Graph Title: check-docstring-first false positive on attribute docstrings · Issue #159 · pre-commit/pre-commit-hooks
X Title: check-docstring-first false positive on attribute docstrings · Issue #159 · pre-commit/pre-commit-hooks
Description: Attribute docstrings, as defined in PEP-257 are strings immediately following top level module names. For example: name = "my variable" """the name used by the module for x, y, and z""" The check-docstring-first incorrectly identifies th...
Open Graph Description: Attribute docstrings, as defined in PEP-257 are strings immediately following top level module names. For example: name = "my variable" """the name used by the module for x, y, and z""" The check-d...
X Description: Attribute docstrings, as defined in PEP-257 are strings immediately following top level module names. For example: name = "my variable" """the name used by the module for x...
Opengraph URL: https://github.com/pre-commit/pre-commit-hooks/issues/159
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"check-docstring-first false positive on attribute docstrings","articleBody":"Attribute docstrings, as [defined in PEP-257](https://www.python.org/dev/peps/pep-0257/#id15) are strings immediately following top level module names. For example:\r\n\r\n```\r\nname = \"my variable\"\r\n\"\"\"the name used by the module for x, y, and z\"\"\"\r\n```\r\n\r\nThe check-docstring-first incorrectly identifies this attribute docstring as a module docstring, indicating either `Multiple module docstrings (first docstring on line N).` or `Module docstring appears after code (code seen on line N).`.\r\n\r\nIn light of this issue, I'm not sure the `check-docstring-first` check has much value at all. At the very least, the check should not be failing when a docstring follows an assignment.","author":{"url":"https://github.com/jaraco","@type":"Person","name":"jaraco"},"datePublished":"2016-12-23T23:56:20.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":10},"url":"https://github.com/159/pre-commit-hooks/issues/159"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:931dbc27-e699-bc42-3ad2-8623c748b63b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C92A:56830:19010D0:210F9BD:6A51D08F |
| html-safe-nonce | 74c4ee8ac87137ebab9ea7fb885becabaec60f71dcc34e887e2cf0a8181bab84 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDOTJBOjU2ODMwOjE5MDEwRDA6MjEwRjlCRDo2QTUxRDA4RiIsInZpc2l0b3JfaWQiOiI3MjUwMzI3NDE3OTE4NzA1ODA3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 1be0b16ec914c616dfd74fa24ddee2fbf5989d03c4d64df8c13fff90f6e39934 |
| hovercard-subject-tag | issue:197438400 |
| github-keyboard-shortcuts | repository,issues,commits,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/pre-commit/pre-commit-hooks/159/issue_layout |
| twitter:image | https://opengraph.githubassets.com/9b4ffc16c0983870fe4e9d8450cf4e0edf98706d7ebf7197ceaebd2182fb28b8/pre-commit/pre-commit-hooks/issues/159 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/9b4ffc16c0983870fe4e9d8450cf4e0edf98706d7ebf7197ceaebd2182fb28b8/pre-commit/pre-commit-hooks/issues/159 |
| og:image:alt | Attribute docstrings, as defined in PEP-257 are strings immediately following top level module names. For example: name = "my variable" """the name used by the module for x, y, and z""" The check-d... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | jaraco |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/pre-commit/pre-commit-hooks git https://github.com/pre-commit/pre-commit-hooks.git |
| octolytics-dimension-user_id | 6943086 |
| octolytics-dimension-user_login | pre-commit |
| octolytics-dimension-repository_id | 17714713 |
| octolytics-dimension-repository_nwo | pre-commit/pre-commit-hooks |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 17714713 |
| octolytics-dimension-repository_network_root_nwo | pre-commit/pre-commit-hooks |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width