Skip to content

Commit c8e237b

Browse files
committed
Fix typos in docs
Fix small typo noticed in doc review
1 parent 9d9d8be commit c8e237b

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
azplugins is a component for [HOOMD-blue][1] which expands its functionality for
44
tackling a variety of problems in soft matter physics. Currently, azplugins is
5-
tested against v4.8.2 of HOOMD-blue. See [CHANGELOG.rst](CHANGELOG.rst) for a
5+
tested against v5.0.0 of HOOMD-blue. See [CHANGELOG.rst](CHANGELOG.rst) for a
66
list of recent development.
77

88
## Compiling azplugins

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ azplugins
88

99
azplugins is a component for `HOOMD-blue`_ which expands its functionality for
1010
tackling a variety of problems in soft matter physics. Currently, azplugins is
11-
tested against v4.8.2 of HOOMD-blue.
11+
tested against v5.0.0 of HOOMD-blue.
1212

1313
Compiling
1414
=========

src/compute.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class CylindricalVelocityField(Compute):
2727
value of this bound is ignored if the number of bins is zero.
2828
upper_bounds (tuple[float]): Upper bounds for each coordinate. The
2929
value of this bound is ignored if the number of bins is zero.
30-
filter (ParticleFilter): HOOMD particles to include in calculation.
30+
filter (hoomd.filter.ParticleFilter): HOOMD particles to include in calculation.
3131
The default value of `None` means no HOOMD particles are included.
3232
include_mpcd_particles (bool): If `True`, include MPCD particles in
3333
the calculation. This argument only takes effect if HOOMD was
@@ -41,19 +41,19 @@ class CylindricalVelocityField(Compute):
4141
.. math::
4242
4343
r = \sqrt{x^2 + y^2} \\
44-
\theta = \arctan(\frac{y}{x}) \\
44+
\theta = \arctan\left(\frac{y}{x}\right) \\
4545
z = z
4646
4747
Before averaging, Cartesian velocity vectors are converted to the
4848
cylindrical coordinate system using the change-of-basis matrix:
4949
5050
.. math::
5151
52-
\begin{pmatrix}
52+
\left(\begin{array}
5353
\cos \theta & \sin \theta & 0 \\
5454
-\sin \theta & \cos \theta & 0 \\
5555
0 & 0 & 1
56-
\end{\pmatrix}
56+
\end{array}\right)
5757
5858
Particles that lie outside the lower and upper bounds are ignored.
5959

0 commit comments

Comments
 (0)