yep, done :)

Rebased branch on origin/master, added name to CONTRIBUTORS

Squashed commits, rebase branch on origin/master

Add test for ping endpoint

Not sure why the Cypress tests are failing...

In T2294#42206, @anlambert wrote:

Please follow these instructions to start hacking on swh source code.

Yeah, I've done this 👍 . I was talking about documentation specific to developing on the web API. For example, the different decorators (like @api_route, @format_document, etc.) available, guidelines on writing docstrings for this module, etc.

Hi, I'd like to take this up :)

Great! Thanks for the patience and review 😃 . Will work on another task after my exams are done 😴

Rebase branch on master

Update commit message

Squashed commits

Change type from Any to str

Fix minor issues

Requested changes made

In D2622#62814, @vlorentz wrote:

You should use a TypeVar for the type of results, so you don't have to use Any every time.

In D2622#62794, @ardumont wrote:

And another one more general, for the docstring, either wrap all parameters with **parameter-name**: description or remove them altogether.

Done. I've left the single ** for the kwargs in the docstring though.

@vlorentz @ardumont
I think I'm done here, please check the code and my comments above.

Apply minor, cosmetic changes

Add type annotations for rehash.py, indexer.py, origin_head.py and metadata.py.

In D2622#62664, @vlorentz wrote:

They are errors, I don't think we should ignore them, but fix the underlying issue;

Not sure if adding a comment notifies the reviewers, so tagging @vlorentz @ardumont

In swh-indexer's indexer.py (code), the run() method of BaseIndexer class has been overriden by a few derived classes. However, I think some of these overridings may be flawed, since when I try to type-annotate them, they're giving the mypy errors: argument of method incompatible with supertype / Signature of "run" incompatible with supertype "BaseIndexer". This is probably because of a violation of the Liskov substitution principle.

Okay great! I'll add the type annotations to the other files too. Thanks

Fix docstring positioning

Remove types from docstring, fix pre-commit-config

I've mentioned it in the comments of the first commit (efa9390af0b7)

Change git hash back to version tag

And does Jenkins also run code in non-master branches through the pipeline?

Thanks for the detailed reply 🙂, and apologies for the delay. Things are clearer now 👍

Hi, I'd like to take up this issue as my first issue here :) . But before I take it up, I just had a few queries: