Skip to content

Commit

Permalink
public function listed (#3666)
Browse files Browse the repository at this point in the history
Fixes #3655
## Work done in this PR
* Adds minimized_vectors to docs
* Fixes versionchanged rendering for minimized_vectors
  • Loading branch information
aditi2906 authored May 16, 2022
1 parent d2a9e0b commit 82d1827
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions package/MDAnalysis/lib/distances.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
.. autofunction:: transform_StoR
.. autofunction:: augment_coordinates(coordinates, box, r)
.. autofunction:: undo_augment(results, translation, nreal)
.. autofunction:: minimize_vectors(vectors, box)
"""
import numpy as np
from numpy.lib.utils import deprecate
Expand Down Expand Up @@ -1587,6 +1588,7 @@ def minimize_vectors(vectors, box):
Same shape and dtype as input. The vectors from the input, but
minimized according to the size of the box.
.. versionadded:: 2.1.0
"""
boxtype, box = check_box(box)
Expand Down

0 comments on commit 82d1827

Please sign in to comment.