diff options
| author | Adam Turner <9087854+AA-Turner@users.noreply.github.com> | 2022-10-05 18:01:14 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-05 18:01:14 (GMT) |
| commit | 0031e62973801d34a9e19ab7bb199e9668e32d7b (patch) | |
| tree | 631d5d18493647b9f0e5856aeeba06740917a1a7 /Doc/c-api/marshal.rst | |
| parent | aeb28f51304ebe2ad9fd6a61b6e4e5a03d288aa1 (diff) | |
| download | cpython-0031e62973801d34a9e19ab7bb199e9668e32d7b.zip cpython-0031e62973801d34a9e19ab7bb199e9668e32d7b.tar.gz cpython-0031e62973801d34a9e19ab7bb199e9668e32d7b.tar.bz2 | |
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (#97768)
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Diffstat (limited to 'Doc/c-api/marshal.rst')
| -rw-r--r-- | Doc/c-api/marshal.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/c-api/marshal.rst b/Doc/c-api/marshal.rst index 1ba18be..8e25968 100644 --- a/Doc/c-api/marshal.rst +++ b/Doc/c-api/marshal.rst @@ -21,9 +21,9 @@ unmarshalling. Version 2 uses a binary format for floating point numbers. .. c:function:: void PyMarshal_WriteLongToFile(long value, FILE *file, int version) - Marshal a :c:type:`long` integer, *value*, to *file*. This will only write + Marshal a :c:expr:`long` integer, *value*, to *file*. This will only write the least-significant 32 bits of *value*; regardless of the size of the - native :c:type:`long` type. *version* indicates the file format. + native :c:expr:`long` type. *version* indicates the file format. .. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version) @@ -43,9 +43,9 @@ The following functions allow marshalled values to be read back in. .. c:function:: long PyMarshal_ReadLongFromFile(FILE *file) - Return a C :c:type:`long` from the data stream in a :c:expr:`FILE*` opened + Return a C :c:expr:`long` from the data stream in a :c:expr:`FILE*` opened for reading. Only a 32-bit value can be read in using this function, - regardless of the native size of :c:type:`long`. + regardless of the native size of :c:expr:`long`. On error, sets the appropriate exception (:exc:`EOFError`) and returns ``-1``. @@ -53,9 +53,9 @@ The following functions allow marshalled values to be read back in. .. c:function:: int PyMarshal_ReadShortFromFile(FILE *file) - Return a C :c:type:`short` from the data stream in a :c:expr:`FILE*` opened + Return a C :c:expr:`short` from the data stream in a :c:expr:`FILE*` opened for reading. Only a 16-bit value can be read in using this function, - regardless of the native size of :c:type:`short`. + regardless of the native size of :c:expr:`short`. On error, sets the appropriate exception (:exc:`EOFError`) and returns ``-1``. |