Page MenuHomeSoftware Heritage

Fix documented return type of metadata_provider_add.
ClosedPublic

Authored by vlorentz on Tue, Nov 27, 6:01 PM.

Details

Summary

As the in-mem storage was written based on this documentation, fix it as well.

Add a test for this behavior.

Depends on D716.

Diff Detail

Repository
rDSTO Storage manager
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Tue, Nov 27, 6:01 PM
vlorentz edited the summary of this revision. (Show Details)Tue, Nov 27, 6:02 PM

Have you checked the impact?

As we exchanged orally earlier, that's more reasonable to fix the docstring to actually explain what the code does (for the indexer i think).
Because, the production is running on code, not on doc ;)

The impact should be solely around the deposit IIRC. That would need checking though.

If we choose to change the currently badly documented api to align with doc, impacts are:

  • new storage version to deploy
  • bump on dependency for those clients (deposit i think)

I did not change the code running in production: the PG Storage's code remains the same. What changes is the doc and the in-mem storage.

ardumont accepted this revision.Thu, Nov 29, 10:20 AM

I did not change the code running in production: the PG Storage's code remains the same. What changes is the doc and the in-mem storage.

Right!

This revision is now accepted and ready to land.Thu, Nov 29, 10:20 AM
This revision was automatically updated to reflect the committed changes.