diff options
author | Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> | 2009-04-25 18:31:20 (GMT) |
---|---|---|
committer | Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> | 2009-04-25 18:31:20 (GMT) |
commit | 84441cc3d51ba339963015720cb8bec0f1fa2266 (patch) | |
tree | 8f7260240934c87b984213bf7afb193a67958696 /Doc | |
parent | 089c5cdd09b2474194a40b4943dff9359db4969c (diff) | |
download | cpython-84441cc3d51ba339963015720cb8bec0f1fa2266.zip cpython-84441cc3d51ba339963015720cb8bec0f1fa2266.tar.gz cpython-84441cc3d51ba339963015720cb8bec0f1fa2266.tar.bz2 |
Reformat prior to editing.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/slice.rst | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/Doc/c-api/slice.rst b/Doc/c-api/slice.rst index 8be9af5..3743ff8 100644 --- a/Doc/c-api/slice.rst +++ b/Doc/c-api/slice.rst @@ -22,34 +22,35 @@ Slice Objects .. cfunction:: PyObject* PySlice_New(PyObject *start, PyObject *stop, PyObject *step) Return a new slice object with the given values. The *start*, *stop*, and - *step* parameters are used as the values of the slice object attributes of the - same names. Any of the values may be *NULL*, in which case the ``None`` will be - used for the corresponding attribute. Return *NULL* if the new object could not - be allocated. + *step* parameters are used as the values of the slice object attributes of + the same names. Any of the values may be *NULL*, in which case the + ``None`` will be used for the corresponding attribute. Return *NULL* if + the new object could not be allocated. .. cfunction:: int PySlice_GetIndices(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step) Retrieve the start, stop and step indices from the slice object *slice*, - assuming a sequence of length *length*. Treats indices greater than *length* as - errors. + assuming a sequence of length *length*. Treats indices greater than + *length* as errors. - Returns 0 on success and -1 on error with no exception set (unless one of the - indices was not :const:`None` and failed to be converted to an integer, in which - case -1 is returned with an exception set). + Returns 0 on success and -1 on error with no exception set (unless one of + the indices was not :const:`None` and failed to be converted to an integer, + in which case -1 is returned with an exception set). - You probably do not want to use this function. If you want to use slice objects - in versions of Python prior to 2.3, you would probably do well to incorporate - the source of :cfunc:`PySlice_GetIndicesEx`, suitably renamed, in the source of - your extension. + You probably do not want to use this function. If you want to use slice + objects in versions of Python prior to 2.3, you would probably do well to + incorporate the source of :cfunc:`PySlice_GetIndicesEx`, suitably renamed, + in the source of your extension. .. cfunction:: int PySlice_GetIndicesEx(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength) - Usable replacement for :cfunc:`PySlice_GetIndices`. Retrieve the start, stop, - and step indices from the slice object *slice* assuming a sequence of length - *length*, and store the length of the slice in *slicelength*. Out of bounds - indices are clipped in a manner consistent with the handling of normal slices. + Usable replacement for :cfunc:`PySlice_GetIndices`. Retrieve the start, + stop, and step indices from the slice object *slice* assuming a sequence of + length *length*, and store the length of the slice in *slicelength*. Out + of bounds indices are clipped in a manner consistent with the handling of + normal slices. Returns 0 on success and -1 on error with exception set. |