DOC: Document function to check versions of arbitrary packages

[david-cortes-intel]

Description

Documents function _package_check_version.

---

Checklist:

Completeness and readability

• I have updated the documentation to reflect the changes or created a separate PR with updates and provided its number in the description, if necessary.
• Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
• I have resolved any merge conflicts that might occur with the base branch.

Testing

• I have run it locally and tested the changes extensively.
• All CI jobs are green or I have provided justification why they aren't.

[icfaust]

idk, shouldnt we promote it out of being a private function at this point?

[david-cortes-intel]

idk, shouldnt we promote it out of being a private function at this point?

I don't think that sort of utility falls into the scope of this library.