-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
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
DOC: Add/remove spaces in snippets and re-format here and there #17976
Conversation
>>> np.empty((2, 3)) # uninitialized, the result may vary | ||
array([[3.73603959e-262, 6.02658058e-154, 6.55490914e-260], | ||
[5.30498948e-313, 3.14673309e-307, 1.00000000e+000]]) |
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.
"may vary" is a special marker understood by our CI tools, I think you might need to put it back where it was (if CI fails).
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.
Interesting that this did not fail.
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.
This is failing in other PRs now, eg https://app.circleci.com/pipelines/github/numpy/numpy/5410/workflows/93d901be-60df-4a79-9d56-a35bdcc5b2f2/jobs/17498/parallel-runs/0/steps/0-106
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.
potential fix in gh-18008
@@ -280,8 +280,8 @@ central part of the array and only prints the corners:: | |||
|
|||
>>> print(np.arange(10000)) | |||
[ 0 1 2 ... 9997 9998 9999] | |||
>>> | |||
>>> print(np.arange(10000).reshape(100,100)) | |||
>>> |
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.
>>> | |
>>> |
otherwise someone's editor will just trim this again.
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.
This largely looks great, thanks!
My only objections would be subjective, that:
- Putting a trailing space after
>>>
isn't helpful, it will probably be stripped in a later commit by accident - Spaces around
b**2
asb ** 2
etc seems unusual - I think some of the column alignment of comments was deliberate, but I don't feel strongly
doc/source/user/quickstart.rst
Outdated
>>> c | ||
array([20, 29, 38, 47]) | ||
>>> b**2 | ||
>>> b ** 2 |
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.
I'd be inclined to avoid spaces around **
@rnarkk Could you make the suggested fixes? |
Thanks @rnarkk |
HI, Thank you so much for providing helpful reviews.
Thank you! |
CI only passed because for some reason circle-ci did not run at all on this PR. |
No description provided.