Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix some invalid escapes in formatter_functions doc strings

Browse Source
This commit is contained in:
Kovid Goyal 2024-11-11 09:04:44 +05:30
parent 47886804ae
commit 3687ad4baf
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/calibre/utils/formatter_functions.py
View File

@ -977,7 +977,7 @@ instance with the value returned by the corresponding template. In
The following example looks for a series with more than one word and uppercases the first word: The following example looks for a series with more than one word and uppercases the first word:
[CODE] [CODE]
program: re_group(field('series'), "(\S* )(.*)", "{$:uppercase()}", "{$}")'} program: re_group(field('series'), "(\\S* )(.*)", "{$:uppercase()}", "{$}")'}
[/CODE] [/CODE]
''') ''')
@ -1321,9 +1321,9 @@ case, an end_index of zero is assumed to be the length of the list.
Examples assuming that the tags column (which is comma-separated) contains "A, B ,C": Examples assuming that the tags column (which is comma-separated) contains "A, B ,C":
[LIST] [LIST]
[*]``{tags:sublist(0,1,\,)}`` returns "A" [*]``{tags:sublist(0,1,\\,)}`` returns "A"
[*]``{tags:sublist(-1,0,\,)}`` returns "C" [*]``{tags:sublist(-1,0,\\,)}`` returns "C"
[*]``{tags:sublist(0,-1,\,)}`` returns "A, B" [*]``{tags:sublist(0,-1,\\,)}`` returns "A, B"
[/LIST] [/LIST]
''') ''')
@ -2256,13 +2256,13 @@ program: finish_formatting(field("series_index"), "05.2f", " - ", " - ")
[/CODE] [/CODE]
Another example: for the template: Another example: for the template:
[CODE] [CODE]
{series:re(([^\s])[^\s]+(\s|$),\1)}{series_index:0>2s| - | - }{title} {series:re(([^\\s])[^\\s]+(\\s|$),\\1)}{series_index:0>2s| - | - }{title}
[/CODE] [/CODE]
use: use:
[CODE] [CODE]
program: program:
strcat( strcat(
re(field('series'), '([^\s])[^\s]+(\s|$)', '\\1'), re(field('series'), '([^\\s])[^\\s]+(\\s|$)', '\\1'),
finish_formatting(field('series_index'), '0>2s', ' - ', ' - '), finish_formatting(field('series_index'), '0>2s', ' - ', ' - '),
field('title') field('title')
) )
@ -2646,7 +2646,7 @@ class BuiltinGlobals(BuiltinFormatterFunction):
``globals(id[=expression] [, id[=expression]]*)`` -- Retrieves "global variables" ``globals(id[=expression] [, id[=expression]]*)`` -- Retrieves "global variables"
that can be passed into the formatter. The name ``id`` is the name of the global that can be passed into the formatter. The name ``id`` is the name of the global
variable. It both declares and initializes local variables with the names of the variable. It both declares and initializes local variables with the names of the
global variables passed in (the ``id``s. If the corresponding variable is not global variables passed in (the ``id`` parameters. If the corresponding variable is not
provided in the globals then it assigns that variable the provided default provided in the globals then it assigns that variable the provided default
value. If there is no default value then the variable is set to the empty value. If there is no default value then the variable is set to the empty
string.) string.)