diff options
| author | Pierce Lopez <pierce.lopez@gmail.com> | 2020-08-07 02:27:37 -0400 |
|---|---|---|
| committer | Pierce Lopez <pierce.lopez@gmail.com> | 2020-08-07 02:34:25 -0400 |
| commit | 94318890c0a917bc537381b28adf5a96116d01dc (patch) | |
| tree | 44288296651c920f0106ef232af1a449edab912b /doc/upgrading.rst | |
| parent | 798d40c3f3e0700501de1588274b69e2b128ad7c (diff) | |
| download | jansson-94318890c0a917bc537381b28adf5a96116d01dc.zip jansson-94318890c0a917bc537381b28adf5a96116d01dc.tar.gz jansson-94318890c0a917bc537381b28adf5a96116d01dc.tar.bz2 | |
doc: do not use references for standard C types or file names
Use double-backtick quoting instead. It has the same effect
(because these links had nowhere to link to) but it does not
result in loud warnings about broken references by default with Sphinx-3.x.
Diffstat (limited to 'doc/upgrading.rst')
| -rw-r--r-- | doc/upgrading.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/upgrading.rst b/doc/upgrading.rst index 9b49046..94ff7de 100644 --- a/doc/upgrading.rst +++ b/doc/upgrading.rst @@ -47,13 +47,13 @@ List of Incompatible Changes **Underlying type of JSON integers** The underlying C type of JSON integers has been changed from - :type:`int` to the widest available signed integer type, i.e. - :type:`long long` or :type:`long`, depending on whether - :type:`long long` is supported on your system or not. This makes + ``int`` to the widest available signed integer type, i.e. + ``long long`` or ``long``, depending on whether + ``long long`` is supported on your system or not. This makes the whole 64-bit integer range available on most modern systems. ``jansson.h`` has a typedef :type:`json_int_t` to the underlying - integer type. :type:`int` should still be used in most cases when + integer type. ``int`` should still be used in most cases when dealing with smallish JSON integers, as the compiler handles implicit type coercion. Only when the full 64-bit range is needed, :type:`json_int_t` should be explicitly used. @@ -69,8 +69,8 @@ List of Incompatible Changes **Unsigned integers in API functions** Version 2.0 unifies unsigned integer usage in the API. All uses of - :type:`unsigned int` and :type:`unsigned long` have been replaced - with :type:`size_t`. This includes flags, container sizes, etc. + ``unsigned int`` and ``unsigned long`` have been replaced + with ``size_t``. This includes flags, container sizes, etc. This should not require source code changes, as both - :type:`unsigned int` and :type:`unsigned long` are usually - compatible with :type:`size_t`. + ``unsigned int`` and ``unsigned long`` are usually + compatible with ``size_t``. |