Clean up adapter documentation #208
Merged
Conversation
This file contains 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
After moving adapters to `core.adapters`, we forgot to also modify the documentation. This fixes the documentation, plus the core APIs are now alphabetically ordered which is easier to scan through.
MichaelWedel
force-pushed
the
add_core_adapter_documentation
branch
from
7600ebf
to
8afe97e
Compare
MichaelWedel
commented
Mar 1, 2017
lewis/adapters/__init__.py
Outdated
| @@ -18,7 +18,7 @@ | |||
| # ********************************************************************* | |||
|
|
|||
| """ | |||
| The core Adapter API is located in :mod:`lewis.core.adapters`. This module on the contains | |||
| The core Adapter API is located in :mod:`lewis.core.adapters`. This package on the contains | |||
MikeHart85
reviewed
Mar 1, 2017
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| adapters/adapters | ||
| adapters/epics | ||
| adapters/modbus | ||
| adapters/stream |
There was a problem hiding this comment.
The titles this generates (based on the rst files in docs/api/adapters/) are:
The EPICS-Adapter
The Modbus Adapter
The Stream-Adapter
The dashes are inconsistent. I think no dash makes more sense?
There was a problem hiding this comment.
Yes, seems better without dashes at all, while we're at it.
added 2 commits
March 1, 2017 11:50
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.
After moving adapters to
core.adapters, we forgot to also modify the documentation. This fixes the documentation, plus the core APIs are now alphabetically ordered which is easier to scan through.