Add documentation to "Referential integrity checker (prototype)" notebook (alldocs-based)

eecavanna commented 1 month ago

The notebook docs/nb/bulk_validation_referential_integrity_check.ipynb is coming up in conversation frequently (e.g. in https://github.com/microbiomedata/nmdc-runtime/issues/576) and at least one team member (me) has have found it difficult to discuss due to not understanding some of the things it does or the author's rationale for having the notebook do those things.

[ ] Address the TODO comments in the notebook that pertain to documenting what it does/the author's rationale
[ ] Run the result by a potential future contributor of the notebook to gauge the sufficiency of the docs

For example:

ssarrafan commented 1 month ago

Looks like there is aPR that may need to be reviewed before this is closed. Moving to new sprint.

PeopleMakeCulture commented 1 month ago

Thanks for opening a new ticket for this!

PeopleMakeCulture commented 1 month ago

@eecavanna Could you look at the updated comments and let us know if that answers your questions?

microbiomedata / nmdc-runtime