mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-04 20:54:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: unintended links replaced with code snippets (I have this part of RST)

Browse Source
This commit is contained in:
Mateusz Pusz
2020-09-07 13:17:06 +02:00
parent c8b60b80c1
commit ed15ef7729
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/faq.rst
View File

@@ -51,8 +51,8 @@ naming and we came up with ``q_`` prefix which results in a creation of
quantity of a provided unit.
Why do we use UDLs reserved for the C++ standard (no `_` prefix)?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Why do we use UDLs reserved for the C++ standard (no ``_`` prefix)?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This library is meant to become a part of the C++ Standard Library at some point
in the future. We decided to work with the target interface to get implementation
@@ -63,8 +63,8 @@ with literals already existing in the language in our initial approach
This approach has some side effects though. We had to disable some compiler warnings
to make it work:
- `/wd4455` on MSVC,
- `-Wno-literal-suffix` on other compilers.
- ``/wd4455`` on MSVC,
- ``-Wno-literal-suffix`` on other compilers.
Text formatting

6
docs/usage.rst
View File

@@ -263,7 +263,7 @@ differences:
`the project's README file <https://github.com/mpusz/units/blob/master/README.md>`_ or on
`the project's Bintray <https://bintray.com/mpusz/conan-mpusz/mp-units%3Ampusz>`_.
3. Force Conan to check for updated recipes `-u` and to build outdated packages `-b outdated`:
3. Force Conan to check for updated recipes ``-u`` and to build outdated packages ``-b outdated``:
.. code-block:: shell
@@ -281,7 +281,7 @@ enough to handle simple dependencies and configurations. If your project setup i
may prefer to use ``cmake`` generator. In such a case the above procedures should be updated as
follows:
1. Specify `cmake` generator in your Conan configuration file:
1. Specify ``cmake`` generator in your Conan configuration file:
.. code-block:: ini
:caption: conanfile.txt
@@ -319,7 +319,7 @@ in **mp-units** repository, you should:
1. Add remotes of additional Conan dependencies.
2. Use the *CMakeLists.txt* from the top-level directory.
3. Obtain Python dependencies.
4. Run Conan with :envvar:`CONAN_RUN_TESTS` = ``True``.
4. Run Conan with `CONAN_RUN_TESTS`_ = ``True``.
.. code-block:: shell