Skip to content

Commit 9a37075

Browse files
committed
No-break space in README
1 parent 003a910 commit 9a37075

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,31 @@ translate untranslated ones (find them using ``make todo``)..
166166
title.
167167

168168

169+
The case of "::"
170+
~~~~~~~~~~~~~~~~
171+
172+
From the reStructuredText point of view, ``::`` glued at the end of a
173+
word means "output ``:`` and introduce a code block", but a ``::``
174+
after a space means "Just introduce a code block".
175+
176+
So in english rst, we see either ``blah blah::`` or ``blah blah. ::``.
177+
178+
In french, we're putting a no-break space before our columns, like:
179+
``Et voilà :``.
180+
181+
Using no-break space in rst is natural, you'll simply write ``Et
182+
voilà ::``, as the ``::`` is not precedded by a normal space it
183+
will output the column and introduce the code block, you're done.
184+
185+
If you don't know how to type a no-break space there's a trick,
186+
translate column column by space, column, space, column column. the
187+
"space column" will render your space and your column as french needs,
188+
and the trailing "space column column" will output nothing and
189+
introduce the code block. No it does not magically inserts a no-break
190+
space, so it's still not really valid french. Yes, better learn how to
191+
type no-break space.
192+
193+
169194
Where to get help
170195
~~~~~~~~~~~~~~~~~
171196

0 commit comments

Comments
 (0)