Appended to docu-string for function make_array and updated function … #588
Conversation
…sample_proportions Added args and return type to docu-string for function make_array. Also updated function sample_proportions to use multinomial method of Generator class per Numpy recommendations: https://numpy.org/doc/stable/reference/random/generated/numpy.random.multinomial.html
| @@ -16,14 +16,19 @@ | |||
| import collections | |||
|
|
|||
| # Change matplotlib formatting. TODO incorporate into a style? | |||
| plt.rcParams["patch.force_edgecolor"] = True | |||
| plt.rcParams['patch.force_edgecolor'] = True | |||
There was a problem hiding this comment.
Unsure why this change is required?
There was a problem hiding this comment.
The use of single quotes maintains consistency with the rest of the codebase where single quotes are used. Honestly, maybe not necessary but might as well.
There was a problem hiding this comment.
Fair enough. Let's leave your changes then :)
datascience/util.py
Outdated
| Args: | ||
| ``elements`` (variadic): elements | ||
| Returns: | ||
| An array of same length as the provided varadic argument ``elements`` |
There was a problem hiding this comment.
Maybe clarify that this is a NumPy array since Python does not have a native array representation type
datascience/util.py
Outdated
| @@ -84,7 +89,7 @@ def plot_normal_cdf(rbound=None, lbound=None, mean=0, sd=1): | |||
|
|
|||
| ``mean`` (numeric): mean/expectation of normal distribution | |||
|
|
|||
| ``sd`` (numeric): standard deviation of normal distribution | |||
| ``sd`` (numeric): standard deviation of normal distribution | |||
There was a problem hiding this comment.
Unsure why this is required
| @@ -254,4 +260,4 @@ def is_non_string_iterable(value): | |||
| return False | |||
| if hasattr(value, '__iter__'): | |||
| return True | |||
| return False | |||
There was a problem hiding this comment.
Can we please maintain the extra line at the end of the file?
Clarified that function make_array returns NumPy array. Added empty line to end of file.
| @@ -16,14 +16,19 @@ | |||
| import collections | |||
|
|
|||
| # Change matplotlib formatting. TODO incorporate into a style? | |||
| plt.rcParams["patch.force_edgecolor"] = True | |||
| plt.rcParams['patch.force_edgecolor'] = True | |||
There was a problem hiding this comment.
Fair enough. Let's leave your changes then :)
| @@ -254,4 +260,4 @@ def is_non_string_iterable(value): | |||
| return False | |||
| if hasattr(value, '__iter__'): | |||
| return True | |||
| return False | |||
[ ] Wrote test for feature
[ ] Added changes to CHANGELOG.md
[ ] Bumped version number (delete if unneeded)
Changes proposed:
Added args and return type to docu-string for function make_array. Also updated function sample_proportions to use multinomial method of Generator class per Numpy recommendations: https://numpy.org/doc/stable/reference/random/generated/numpy.random.multinomial.html