From 91d94979111eb8b1815d46029052cf39cc535570 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Wed, 4 Mar 2015 18:16:26 -0800 Subject: [PATCH] Fix markup --- ChangeLog.rst | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/ChangeLog.rst b/ChangeLog.rst index 04436e05..0bbc26fb 100644 --- a/ChangeLog.rst +++ b/ChangeLog.rst @@ -3,38 +3,44 @@ * More efficient implementation of variadic formatting functions. -* `Writer::Format` now has a variadic overload:: +* ``Writer::Format`` now has a variadic overload: + + .. code:: c++ Writer out; out.Format("Look, I'm {}!", "variadic"); * For efficiency and consistency with other overloads, variadic overload of - the `Format` function now returns `Writer` instead of `std::string`. - Use the `str` function to convert it to `std::string`:: + the ``Format`` function now returns ``Writer`` instead of ``std::string``. + Use the ``str`` function to convert it to ``std::string``: + + .. code:: c++ std::string s = str(Format("Look, I'm {}!", "variadic")); -* Replaced formatter actions with output sinks: `NoAction` -> `NullSink`, - `Write` -> `FileSink`, `ColorWriter` -> `ANSITerminalSink`. This improves - naming consistency and shouldn't affect client code unless these classes - are used directly which should be rarely needed. +* Replaced formatter actions with output sinks: ``NoAction`` -> ``NullSink``, + ``Write`` -> ``FileSink``, ``ColorWriter`` -> ``ANSITerminalSink``. + This improves naming consistency and shouldn't affect client code unless + these classes are used directly which should be rarely needed. -* Added `ThrowSystemError` function that formats a message and throws - `SystemError` containing the formatted message and system-specific error - description. For example, the following code:: +* Added ``ThrowSystemError`` function that formats a message and throws + ``SystemError`` containing the formatted message and system-specific error + description. For example, the following code + + .. code:: c++ FILE *f = fopen(filename, "r"); if (!f) ThrowSystemError(errno, "Failed to open file '{}'") << filename; - will throw `SystemError` exception with description + will throw ``SystemError`` exception with description "Failed to open file '': No such file or directory" if file doesn't exist. * Support for `AppVeyor `_ continuous integration platform. -* `Format` now throws `SystemError` in case of I/O errors. +* ``Format`` now throws ``SystemError`` in case of I/O errors. * Improve test infrastructure. Print functions are now tested by redirecting the output to a pipe.