Details

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.

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/550/ for more details.

Harbormaster completed remote builds in B6534: Diff 5539.Jun 27 2019, 7:58 PM

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

nope

Rebased master

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/552/ for more details.

Harbormaster completed remote builds in B6536: Diff 5541.Jun 27 2019, 8:25 PM

vlorentz accepted this revision.Jun 27 2019, 11:02 PM

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.

Closed by commit rDWAPPSb2555fabb0fc: Reformatted docstrings wherever possible (authored by twitu). · Explain WhyJun 28 2019, 5:24 AM