-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: example requires numpy to be imported #1622
Conversation
A user copying and pasting the existing sample will hit the following error. ``` NameError: name 'numpy' is not defined ``` This is avoidable by including import numpy in the example.
This PR closes: #1 |
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@alexcg1 do we want to add this or we assume it can be incomplete?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
Codecov Report
@@ Coverage Diff @@
## master #1622 +/- ##
==========================================
+ Coverage 84.14% 84.86% +0.72%
==========================================
Files 127 127
Lines 6642 6642
==========================================
+ Hits 5589 5637 +48
+ Misses 1053 1005 -48
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was intentionally removed for saving one-line, example code snippets are for showing capability in a quick & lean way. It is optimized for size, not for reproducibility. For reproducibility, I will use repl.it for all example snippet.
will merge for now as it is just one line code change. For other example snippet, please see my comment above |
Very much agreed with @hanxiao . README should be for showing /how/ code works in general, not showing /exact/ code to pull it off |
A user copying and pasting the existing sample will hit the following error.
This is avoidable by including import numpy in the example.