Skip to content

Commit

Permalink
Fix docs now that I have implemented the error raising.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzuhone committed Mar 29, 2021
1 parent 4d61851 commit 77480bc
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/source/analyzing/filtering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,12 @@ The following exclude and include functions are supported:

.. warning::

Cut regions can have unexpected results with particle fields, or often not work
at all with some operations. If you want to filter particle fields, see the
next section :ref:`filtering-particles` instead.
Cut regions are unstable when used on particle fields. Though you can create
a cut region using a mesh field or fields as a filter and then obtain a
particle field within that region, you cannot create a cut region using
particle fields in the filter, as yt will currently raise an error. If
you want to filter particle fields, see the next section
:ref:`filtering-particles` instead.

.. _filtering-particles:

Expand Down

0 comments on commit 77480bc

Please sign in to comment.