Page MenuHomeSoftware Heritage
Differential D638

Fix docstrings in swh-indexer
ClosedPublic
Actions

Authored by douardda on Nov 9 2018, 11:10 AM.

Details

Reviewers
vlorentz
ardumont
Group Reviewers
Reviewers
Commits
rDCIDXdeed261c7fd3: Fix docstrings in swh.indexer.storage
rDCIDX72c3c18fcc21: Use a symlink to the README.md file in docs/
Summary

Use a symlink to the README.md file in docs/

instead of cp it in the Makefile.

Fix dosctring of swh.indexer.storage

Test Plan

make -C docs html should not report any warning

Diff Detail

Repository
rDCIDX Metadata indexer
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

douardda created this revision.Nov 9 2018, 11:10 AM
Herald added a reviewer: Reviewers. · View Herald TranscriptNov 9 2018, 11:10 AM
swh-public-ci added a subscriber: swh-public-ci.Nov 9 2018, 11:13 AM

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

Harbormaster completed remote builds in B2279: Diff 1982.Nov 9 2018, 11:13 AM
vlorentz accepted this revision.Nov 9 2018, 11:27 AM
This revision is now accepted and ready to land.Nov 9 2018, 11:27 AM
ardumont accepted this revision.Nov 9 2018, 11:27 AM
ardumont added a subscriber: ardumont.

Thanks.

docs/README.md
1

So it worked apparently! Awesome!

swh/indexer/storage/__init__.py
97 ↗(On Diff #1982)

We use the imperative form.

149 ↗(On Diff #1982)

Why simple star here and double ones in the Args section?

douardda marked 4 inline comments as done.Nov 9 2018, 1:32 PM
douardda added inline comments.
docs/README.md
1

it works for me ©

swh/indexer/storage/__init__.py
149 ↗(On Diff #1982)

because I mistyped my regex 😄

douardda updated this revision to Diff 1997.Nov 9 2018, 1:49 PM
douardda marked 2 inline comments as done.

Use bold for dict keys everywhere

douardda updated this revision to Diff 1998.Nov 9 2018, 1:51 PM
douardda marked an inline comment as done.

Use imperative form in content_mimetype_missing()'s docstring

swh-public-ci added a comment.Nov 9 2018, 1:52 PM

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

Harbormaster completed remote builds in B2297: Diff 1997.Nov 9 2018, 1:52 PM
swh-public-ci added a comment.Nov 9 2018, 1:56 PM

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

Harbormaster completed remote builds in B2298: Diff 1998.Nov 9 2018, 1:56 PM
Closed by commit rDCIDX72c3c18fcc21: Use a symlink to the README.md file in docs/ (authored by douardda). · Explain WhyNov 9 2018, 2:53 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
docs/
1 line
1 line
2 lines

Diff 2002

View Options

docs/.gitignore

Loading...
View Options

docs/README.md

Loading...
View Options

docs/index.rst

Loading...
About · Developer information · Legal