Add new public function Pkg.satisfies_compat(::VersionNumber, ::String), and add (to docs) some examples of checking [compat] entries

[DilumAluthge]

Co-authored-by: Miles Cranmer

Replacement for #3847 (closes #3847).

This is an alternative for #3847. AFAICT, it satisfies the use case of #3847, and has the advantages of not exposing internal types, and not renaming any internal functions.

I'm not at all married to the name satisfies_compat - I'm happy to change it.

[DilumAluthge]

cc: @MilesCranmer

[IanButterworth]

SGTM +1

[DilumAluthge]

CHANGELOG entry added.

[DilumAluthge]

I've added a few tests.

We also have a few doctests in the docstring.

[IanButterworth]

SGTM but worth getting @KristofferC review too

[KristofferC]

I think we can reduce the number of examples a bit, I think people will understand how to use it after one or two examples.

[KristofferC]

LGTM, with the note that I think we can reduce the number of examples given a bit.

[KristofferC]

#1263 wants to get the range returned. Perhaps we can also do that (but only document that you can call in on that range). Then you would also get the pretty printing.

[IanButterworth]

Could that be a follow-on? I can tidy up the examples to get this merged if so.

[KristofferC]

But if we go with that there is no need for the satisfies_compat method at all?

[IanButterworth]

Can all semver specs be represented by a single range object?

julia> Pkg.Types.semver_spec("1, 2, =3.0, 3.2")
VersionSpec("[1 - 2, 3.0.0, 3.2.0 - 3]")

[KristofferC]

A VersionSpec can contain a collection of ranges.

[IanButterworth]

So how does the user test inclusion of a version in that collection of ranges?

You're proposing returning a range not a VersionSpec?

[KristofferC]

A VersionSpec is a single object (that can internally have many ranges in it) , that you can test in with a VersionNumber with.

[IanButterworth]

Ok, I was understanding that you wanted to return a single range, not the VersionSpec (which would need to become public, as discussed in #3847 (comment) which lead to this alternative PR)

#1263 wants to get the range returned. Perhaps we can also do that (but only document that you can call in on that range).

[IanButterworth]

Making VersionSpec public seems fine to me.

[KristofferC]

Ah sorry, I should have been more accurate and said VersionSpec.