Rename EntryPoint's _from_text() to from_text() and document it - [closed]

[jaraco]

In GitLab by @jwodder on Mar 26, 2020, 17:39

Merges expose-ep-read-text -> master

Closes #114

[jaraco]

In GitLab by @codecov on Mar 26, 2020, 17:44

Codecov Report

Merging #117 into master will not change coverage by %.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #117   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          260       260           
  Branches        21        21           
=========================================
  Hits           260       260           

Impacted Files	Coverage Δ
importlib_metadata/__init__.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 654dc66...584ef41. Read the comment docs.

[jaraco]

In GitLab by @jwodder on Mar 26, 2020, 17:45

@jaraco I realize that you gave me an alternative way to accomplish what I want without the need for this PR. You don't have to merge this; I'd just prefer it if you did.

[jaraco]

In GitLab by @jaraco on Mar 27, 2020, 24:39

My main reservation with this change is that it makes (or strengthens) the format of the entry points (as) a public interface. Clearly, it was intended to remain a private interface, allowing for more flexibility for changing the underlying format. What's the motivation for accepting this change and burning that bridge?

[jaraco]

In GitLab by @jwodder on Mar 27, 2020, 16:45

So you're saying _from_text shouldn't be public in case one day there's also (say) a _from_json and you want the decision for choosing which to call to be none of the end-users' business? OK, then; I defer to your vision for the project.

[jaraco]

In GitLab by @jwodder on Mar 27, 2020, 16:45

closed

[jaraco]

In GitLab by @jaraco on Mar 28, 2020, 24:29

So you're saying _from_text shouldn't be public?

Yes, essentially. I don't feel strongly about it, but I am cautious about expanding the advertised API surface without a compelling use-case.

Still, I welcome you to use _from_text, knowing it's a private interface and subject to change, if that suits your needs. Or if you feel having parsing support is really valuable and belongs here, just write up a justification. Thanks for the good spirit.