Page MenuHomeSoftware Heritage

Reformat docstring in utils.py
ClosedPublic

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

Details

Summary

In reference to T1836
Reformat docstring in utils.py, stat.py, directory.py

Diff Detail

Repository
rDWAPPS Web applications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

This revision is now accepted and ready to land.Jun 27 2019, 11:03 AM

Sorry, could you squash your commits before merging? (ie. make a single commit instead of three).

You can do it with git rebase -i master

This revision now requires changes to proceed.Jun 27 2019, 11:04 AM

Reformat docstring wherever possible

While formatting the documents I realized that whoever was writing was try to keep line lengths short but they followed an arbitrary line length which was longer than 80 character. Since # noqa was applied these formatting errors did not pop up. I think a lot of this can be resolved if there can be a guideline to add a vertical ruler to the editor at 80 chars.

Also some of the documentation is swh-web is very hard to find. I just can't find where the documentation for swh-web/swh/web/api/views/utils.py is rendered.

In D1650#38108, @twitu wrote:

Also some of the documentation is swh-web is very hard to find. I just can't find where the documentation for swh-web/swh/web/api/views/utils.py is rendered.

I don't think it is, because it's not actually part of the API.

Aren't all doc strings rendered at some place with documentation for packages, sub modules the functions they contain?

This revision is now accepted and ready to land.Jun 27 2019, 11:02 PM

It seems like my revision is already in origin master. There are no changes to push. Should I close this revision.

This revision was automatically updated to reflect the committed changes.