Skip to content

Commit 112024d

Browse files
committed
Escape pipe symbol in selector docstrings
Sphinx decided it was a link to something
1 parent a57e69a commit 112024d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

cadquery/selectors.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ class ParallelDirSelector(BaseDirSelector):
198198
Linear Edges
199199
Planar Faces
200200
201-
Use the string syntax shortcut |(X|Y|Z) if you want to select based on a cardinal direction.
201+
Use the string syntax shortcut \|(X|Y|Z) if you want to select based on a cardinal direction.
202202
203203
Example::
204204
@@ -679,7 +679,7 @@ def _getVector(self, pr):
679679
def filter(self, objectList):
680680
r"""
681681
selects minimum, maximum, positive or negative values relative to a direction
682-
[+|-|<|>|] <X|Y|Z>
682+
``[+|-|<|>|] <X|Y|Z>``
683683
"""
684684
return self.mySelector.filter(objectList)
685685

@@ -753,7 +753,7 @@ class StringSyntaxSelector(Selector):
753753
754754
***Modfiers*** are ``('|','+','-','<','>','%')``
755755
756-
:|:
756+
:\|:
757757
parallel to ( same as :py:class:`ParallelDirSelector` ). Can return multiple objects.
758758
:#:
759759
perpendicular to (same as :py:class:`PerpendicularDirSelector` )
@@ -776,11 +776,11 @@ class StringSyntaxSelector(Selector):
776776
:and:
777777
Logical AND, e.g. >X and >Y
778778
:or:
779-
Logical OR, e.g. |X or |Y
779+
Logical OR, e.g. \|X or \|Y
780780
:not:
781781
Logical NOT, e.g. not #XY
782782
:exc(ept):
783-
Set difference (equivalent to AND NOT): |X exc >Z
783+
Set difference (equivalent to AND NOT): \|X exc >Z
784784
785785
Finally, it is also possible to use even more complex expressions with nesting
786786
and arbitrary number of terms, e.g.

0 commit comments

Comments
 (0)