diff --git a/package/AUTHORS b/package/AUTHORS index c4ee0e250a..9e29bd33d7 100644 --- a/package/AUTHORS +++ b/package/AUTHORS @@ -281,6 +281,7 @@ Chronological list of authors - Shubham Mittal - Charity Grey - Sai Udayagiri + - Eesh Saxena External code ------------- diff --git a/package/CHANGELOG b/package/CHANGELOG index 80385b3299..715f0b6368 100644 --- a/package/CHANGELOG +++ b/package/CHANGELOG @@ -17,11 +17,15 @@ The rules for this file: ??/??/?? IAlibay, orbeckst, marinegor, tylerjereddy, ljwoods2, marinegor, spyke7, talagayev, tanii1125, BradyAJohnston, hejamu, jeremyleung521, harshitgajjela-droid, kunjsinha, aygarwal, jauy123, Dreamstick9, - ollyfutur, Amarendra22, charity-g, ParthUppal523 + ollyfutur, Amarendra22, charity-g, ParthUppal523, eeshsaxena * 2.11.0 Fixes + * Fixed several docstrings that documented parameter names not matching + their signatures: ``util.which`` (``programe`` -> ``program``), + ``add_transformations`` (``transform_list`` -> ``transformations``) and + ``GuesserBase.is_guessable`` (``guess`` -> ``attr_to_guess``) (PR #5412). * The `principal_axes` method in :class:`Masses` now uses `np.linalg.eigh` instead of `np.linalg.eig`, improving numerical stability. This may lead to slightly different results from previous diff --git a/package/MDAnalysis/coordinates/memory.py b/package/MDAnalysis/coordinates/memory.py index 07c31fa225..12bf38ec2e 100644 --- a/package/MDAnalysis/coordinates/memory.py +++ b/package/MDAnalysis/coordinates/memory.py @@ -675,7 +675,7 @@ def add_transformations(self, *transformations): Parameters ---------- - transform_list : list + transformations : list list of all the transformations that will be applied to the coordinates See Also diff --git a/package/MDAnalysis/guesser/base.py b/package/MDAnalysis/guesser/base.py index c7bcc21e82..712f3d6e21 100644 --- a/package/MDAnalysis/guesser/base.py +++ b/package/MDAnalysis/guesser/base.py @@ -110,7 +110,7 @@ def is_guessable(self, attr_to_guess): Parameters ---------- - guess: str + attr_to_guess: str Attribute to be guessed then added to the Universe Returns diff --git a/package/MDAnalysis/lib/util.py b/package/MDAnalysis/lib/util.py index 0f497892f1..b3af22a9e2 100644 --- a/package/MDAnalysis/lib/util.py +++ b/package/MDAnalysis/lib/util.py @@ -577,7 +577,7 @@ def which(program): Parameters ---------- - programe : str + program : str name of the executable Returns