Include entry points as an optional feature #297
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kgryte
reviewed
Nov 4, 2021
kgryte
reviewed
Nov 4, 2021
kgryte
reviewed
Nov 4, 2021
kgryte
reviewed
Nov 4, 2021
rgommers
reviewed
Nov 4, 2021
| @@ -369,6 +369,31 @@ recommended not to add other functions or objects, because that may make it | |||
| harder for users to write code that will work with multiple array libraries. | |||
|
|
|||
|
|
|||
| ### Discoverability | |||
|
|
|||
There was a problem hiding this comment.
This is a bit cryptic for a reader, like why does it exist? what goes wrong if an entrypoint is not implemented? The one word may is not enough, I'll try to add a note with rationale. Especially because this is in the "Purpose and scope" section, that is important.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #244 by adding a subsection that goes over entry points as an optional thing to adopt in the "How to adopt this API" section.
I thought to give an example of how it would be used, like how
xp = x.__array_namespace__()is shown above. It's a bit awkward due to the dict interface deprecation, but it seemed better to address it in the code example than in a separate note.I also thought to give an example of defining an entry point in setup.py i.e.
entry_points={'array_api': ['package_name = package_name.array_api']}, but that is a bit out-of-scope really.