Awkward wording in docstring for find_matches()

[brettcannon]

The docstring says the identifier parameter "identifies the dependency matches of which should be returned." Is this trying to say it "it identifies the dependency for which matches should be returned"?

[uranusjr]

It’s trying to say (iirc) for each candidate returned by find_matches, identify(candidate) should return the same value as identifier. A rewording would be helpful…

[brettcannon]

Does that mean identify() can be called on a candidate as well? The identify() docstring only mentions requirements:

resolvelib/src/resolvelib/providers.py

Lines 5 to 9 in 77b256c

	"""Given a requirement, return an identifier for it.
	This is used to identify a requirement, e.g. whether two requirements
	should have their specifier parts merged.
	"""

The typing suggests it can be either, but the README says " "requirement" ... SHOULD NOT be used when describing a Candidate, to avoid confusion", so that docstring might also be misleading.

And I'm happy to submit a PR to clear up the wording on all of this once I understand exactly what's expected.

[uranusjr]

Yes; the argument is called requirement_or_candidate (and typed as Union[RT, CT]). The docstring does indeed need some fixup.

[brettcannon]

I'll create a PR to try to clarify both docstrings.

[brettcannon]

#138 is my attempt to clarify things.