Add real.py module to API documentation #40
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
Added imdlib.real module to docs/api.rst so that real-time data functions (open_real_data and get_real_data) appear in the API reference documentation. The real module was missing from the API docs despite being a functional part of the library.
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.
Summary
Adds the missing
imdlib.realmodule to API documentation reference.Problem
The
imdlib.realmodule contains important real-time data functions:open_real_data()get_real_data()However, these functions were not appearing in the API documentation at https://imdlib.readthedocs.io/en/latest/api.html
Solution
Added
imdlib.realtodocs/api.rstusing the automodapi directive.Changes
docs/api.rstimdlib.realmodule