[SERVER-35195] Remove Python linting rule requiring docstring for magic functions Created: 23/May/18 Updated: 29/Oct/23 Resolved: 04/Jun/18 |
|
| Status: | Closed |
| Project: | Core Server |
| Component/s: | Testing Infrastructure |
| Affects Version/s: | 4.0.0-rc0 |
| Fix Version/s: | 4.0.0-rc2, 4.1.1 |
| Type: | Improvement | Priority: | Trivial - P5 |
| Reporter: | Robert Guo (Inactive) | Assignee: | Robert Guo (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Backwards Compatibility: | Fully Compatible | ||||
| Backport Requested: |
v4.0, v3.6
|
||||
| Sprint: | TIG 2018-06-04, TIG 2018-06-18 | ||||
| Participants: | |||||
| Story Points: | 1 | ||||
| Description |
|
Add an exception for rule d105 in pydocstyles and remove redundant magic method docstrings. docstrings for magic functions don't provide much value. They're mostly useful for describing parameters, which is not checked by d105. |
| Comments |
| Comment by Githook User [ 04/Jun/18 ] |
|
Author: {'username': 'guoyr', 'name': 'Robert Guo', 'email': 'robert.guo@10gen.com'}Message: (cherry picked from commit 89eceaa7ca24bbb275062b1648a6df0b916778cd) |
| Comment by Githook User [ 04/Jun/18 ] |
|
Author: {'username': 'guoyr', 'name': 'Robert Guo', 'email': 'robert.guo@10gen.com'}Message: |