Skip to content

Commit

Permalink
Escape pipe symbol in selector docstrings
Browse files Browse the repository at this point in the history
Sphinx decided it was a link to something
  • Loading branch information
marcus7070 committed Feb 25, 2021
1 parent a57e69a commit 112024d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions cadquery/selectors.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ class ParallelDirSelector(BaseDirSelector):
Linear Edges
Planar Faces
Use the string syntax shortcut |(X|Y|Z) if you want to select based on a cardinal direction.
Use the string syntax shortcut \|(X|Y|Z) if you want to select based on a cardinal direction.
Example::
Expand Down Expand Up @@ -679,7 +679,7 @@ def _getVector(self, pr):
def filter(self, objectList):
r"""
selects minimum, maximum, positive or negative values relative to a direction
[+|-|<|>|] <X|Y|Z>
``[+|-|<|>|] <X|Y|Z>``
"""
return self.mySelector.filter(objectList)

Expand Down Expand Up @@ -753,7 +753,7 @@ class StringSyntaxSelector(Selector):
***Modfiers*** are ``('|','+','-','<','>','%')``
:|:
:\|:
parallel to ( same as :py:class:`ParallelDirSelector` ). Can return multiple objects.
:#:
perpendicular to (same as :py:class:`PerpendicularDirSelector` )
Expand All @@ -776,11 +776,11 @@ class StringSyntaxSelector(Selector):
:and:
Logical AND, e.g. >X and >Y
:or:
Logical OR, e.g. |X or |Y
Logical OR, e.g. \|X or \|Y
:not:
Logical NOT, e.g. not #XY
:exc(ept):
Set difference (equivalent to AND NOT): |X exc >Z
Set difference (equivalent to AND NOT): \|X exc >Z
Finally, it is also possible to use even more complex expressions with nesting
and arbitrary number of terms, e.g.
Expand Down

0 comments on commit 112024d

Please sign in to comment.