Add sphinx doc in PyBind file. Provide more documentation #292
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
jetfuel
requested review from
Superjomn,
cs2be,
varunarora,
nickyfantasy and
jacquesqiao
nickyfantasy
previously approved these changes
Mar 5, 2018
|
fixes: #289 |
jetfuel
force-pushed
the
addSphinxDocInPyBind
branch
from
ee09e98
to
fa4ac1c
Compare
nickyfantasy
approved these changes
Mar 6, 2018
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.
The PyBind class wraps C++ implementation and we should expose the C++ API information to our users.
Our code creates ScalarWriter__float, ScalarWriter__int, and ScalarWriter__double for ScalarWriter class.
I am choosing just ScalarWriter__float to make the documentation clear. If you find a better way, please let me know.
same thing to HistogramWriter.