From d534113f1313fe475c8b457643ccd2c3452ee257 Mon Sep 17 00:00:00 2001 From: Sylvia Biscoveanu <sylvia.biscoveanu@ligo.org> Date: Tue, 15 Oct 2019 18:23:27 -0500 Subject: [PATCH] Add description for latex_label format --- docs/prior.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/prior.txt b/docs/prior.txt index fe655557f..b6f48ed1a 100644 --- a/docs/prior.txt +++ b/docs/prior.txt @@ -28,7 +28,10 @@ simple example that sets a uniform prior for :code:`a`, and a fixed value for priors['b'] = 5 Notice, that the :code:`latex_label` is optional, but if given will be used -when generating plots. +when generating plots. Latex label strings containing escape characters like :code:`\t` +should either be preceded by :code:`r'` or include an extra backslash. As an example, +either :code:`r'$\theta$'` or :code:`'$\\theta$'` is permissable. For a list of +recognized escape sequences, see the `python docs <https://docs.python.org/2.0/ref/strings.html>`_. -------------- Default priors -- GitLab