Fix entry points for 3rd party interfaces #389
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
Codecov Report
@@ Coverage Diff @@
## develop #389 +/- ##
===========================================
+ Coverage 59.34% 59.34% +<.01%
===========================================
Files 55 55
Lines 4243 4248 +5
===========================================
+ Hits 2518 2521 +3
- Misses 1725 1727 +2 |
christiansandberg
changed the title
felixdivo
approved these changes
Aug 11, 2018
doc/interfaces.rst
Outdated
| @@ -25,15 +25,15 @@ The available interfaces are: | |||
| interfaces/virtual | |||
|
|
|||
| Additional interfaces can be added via a plugin interface. An external package | |||
| can register a new interface by using the ``python_can.interface`` entry point. | |||
| can register a new interface by using the ``can.interface`` entry point in setup.py. | |||
There was a problem hiding this comment.
maybe write: "by using the can.interface entry point in its setup.py"
| @@ -28,4 +28,10 @@ | |||
| for interface in iter_entry_points('can.interface') | |||
| }) | |||
|
|
|||
| # Old entry point name. May be removed in 3.0. | |||
There was a problem hiding this comment.
Maybe, we should print a warning then, urging people to use the newer one.
doc/interfaces.rst
Outdated
| @@ -25,15 +25,15 @@ The available interfaces are: | |||
| interfaces/virtual | |||
|
|
|||
| Additional interfaces can be added via a plugin interface. An external package | |||
| can register a new interface by using the ``python_can.interface`` entry point. | |||
| can register a new interface by using the ``can.interface`` entry point in setup.py. | |||
|
|
|||
| The format of the entry point is ``interface_name=module:classname`` where | |||
| ``classname`` is a :class:`can.BusABC` concrete implementation. | |||
There was a problem hiding this comment.
Maybe: is a concrete :class:can.BusABC implementation
|
Looks good to me! |
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.
Fixes backwards incompatible change introduced in 2.2.0. Updated documentation to new entry point.