8000 DOC: Documentation fixes by madphysicist · Pull Request #7415 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

DOC: Documentation fixes #7415

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 14, 2016
+108 −100
Merged

DOC: Documentation fixes #7415

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a4ff44
DOC: Updates to documentation from perusing it in detail.
madphysicist Feb 24, 2016
133e892
MAINT: Wrapped some docstrings and fixed typo
madphysicist Mar 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
DOC: Updates to documentation from perusing it in detail. 
[ci skip]
  • Loading branch information
@madphysicist
madphysicist committed Mar 14, 2016
commit 7a4ff44b056eb8f8a53fbc196ef53666523bfca3
2 changes: 1 addition & 1 deletion doc/source/reference/c-api.array.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ From other objects

Force a cast to the output type even if it cannot be done
safely. Without this flag, a data cast will occur only if it
can be done safely, otherwise an error is reaised.
can be done safely, otherwise an error is raised.

.. c:var:: NPY_ARRAY_UPDATEIFCOPY

Expand Down
4 changes: 2 additions & 2 deletions doc/source/reference/c-api.types-and-structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -871,8 +871,8 @@ PyArrayIter_Type
.. c:member:: npy_intp *PyArrayIterObject.backstrides

How many bytes needed to jump from the end of a dimension back
to its beginning. Note that *backstrides* [k]= *strides* [k]*d
*ims_m1* [k], but it is stored here as an optimization.
to its beginning. Note that `backstrides`[k]= `strides`[k] *
`dims_m1`[k], but it is stored here as an optimization.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't render correctly. You can put single backticks around the whole expression, possibly with a :code: preceding, e.g.

       How many bytes needed to jump from the end of a dimension back
       to its beginning. Note that :code:`backstrides[k]= strides[k] *
       dims_m1[k]`, but it is stored here as an optimization.

You can check things by changing to the doc directory, doing make html and then viewing build/html/index.html in a browser.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note also for future reference that bare single backticks are basically never right in vanilla Sphinx. They assign some text the "default role". If a particular build has been configured to set this to something useful, and you know what that is and it's local convention to use it, then great, but otherwise it's better to be explicit :-). (This is definitely the most annoying incompatibility between markdown and rst.)


.. c:member:: npy_intp *PyArrayIterObject.factors

Expand Down
0