Page MenuHomeSoftware Heritage
Differential D2618

Fix Sphinx 2.x warnings
ClosedPublic
Actions

Authored by anlambert on Feb 3 2020, 2:59 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Commits
rDWAPPSf0cbc5276c36: Fix Sphinx 2.x warnings
Summary

This fixes the following Sphinx 2.x warnings in swh-web:

/home/antoine/swh/swh-environment/swh-web/swh/web/browse/utils.py:docstring of swh.web.browse.utils.get_snapshot_context:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/origin_save.py:docstring of swh.web.common.origin_save.get_save_origin_requests:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/origin_visits.py:docstring of swh.web.common.origin_visits.get_origin_visits:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_revision_log:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_revision_log_by:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_object:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc

This raises the question that maybe we should centralize common used exceptions in swh-core
but first let's simply fix the documentation build on Jenkins.

Related to T2264

Diff Detail

Repository
rDWAPPS Web applications
Branch
fix-sphinx-2-warnings
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 10424
Build 15519: Cypress tests for swh-web diffsJenkins
Build 15518: tox-on-jenkinsJenkins
Build 15517: arc lint + arc unit

Event Timeline

anlambert created this revision.Feb 3 2020, 2:59 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 3 2020, 2:59 PM
swh-public-ci added a comment.Feb 3 2020, 3:07 PM

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

swh-public-ci added a comment.Feb 3 2020, 3:13 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/524/ for more details.

Harbormaster completed remote builds in B10422: Diff 9360.Feb 3 2020, 3:13 PM
vlorentz accepted this revision.Feb 3 2020, 3:25 PM
vlorentz added a subscriber: vlorentz.

You're stealing easy hacks again :/

This revision is now accepted and ready to land.Feb 3 2020, 3:25 PM
anlambert added a comment.Feb 3 2020, 3:30 PM

You're stealing easy hacks again :/

I known but I am sick and that the best that I can do today ...

I let the other warnings for newcomers then.

vlorentz added a comment.Feb 3 2020, 3:40 PM
In D2618#62328, @anlambert wrote:

I known but I am sick and that the best that I can do today ...

You should rest!

anlambert updated this revision to Diff 9363.Feb 3 2020, 3:58 PM

Reference Easy hack task in commit message instead

anlambert added a comment.Feb 3 2020, 4:04 PM

Easy hack task to fix documentation warnings created: T2265

Landing this and going back to rest.

This revision was landed with ongoing or failed builds.Feb 3 2020, 4:05 PM
Closed by commit rDWAPPSf0cbc5276c36: Fix Sphinx 2.x warnings (authored by anlambert). · Explain Why
This revision was automatically updated to reflect the committed changes.
anlambert added a commit: rDWAPPSf0cbc5276c36: Fix Sphinx 2.x warnings.
swh-public-ci added a comment.Feb 3 2020, 4:07 PM

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

swh-public-ci added a comment.Feb 3 2020, 4:16 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/525/ for more details.

Harbormaster completed remote builds in B10424: Diff 9363.Feb 3 2020, 4:16 PM

Revision Contents
Changeset List

PathSize
swh/
web/
browse/
3 lines
common/
3 lines
2 lines
9 lines

Diff 9363

View Options

swh/web/browse/utils.py

Loading...
View Options

swh/web/common/origin_save.py

Loading...
View Options

swh/web/common/origin_visits.py

Loading...
View Options

swh/web/common/service.py

Loading...
About · Developer information · Legal