Page MenuHomeSoftware Heritage

Reformat docstrings for max line length
AbandonedPublic

Authored by twitu on Jun 27 2019, 6:08 AM.

Details

Summary

In reference to T1836

Diff Detail

Repository
rDDEP Push deposit
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 6511
Build 9067: tox-on-jenkinsJenkins
Build 9066: arc lint + arc unit

Event Timeline

It is odd that py3 test cases are failing although I have only changed to formatting of the docstrings.

These are not docstring.

A docstring is a string that is either at the very top of a function, or on the line right after a variable assignment.

What you changed are regular strings, which are assigned to a variable (eg. self.atom_error_with_decimal = b"""<content of the string>"""), so changing them changes the value of the variable.

A source of confusion is that triple double quotes (""") are often used for docstrings, but what they actually represent is a multi-line strings. (And docstrings are a popular use of multi-line strings, hence the confusion)

I will close this diff since no changes required for swh-deposit. With complex cases like this there is no way this process can be automated.