Missing argument descriptions in some docstrings

[matt-graham]

Submitting as part of JOSS review openjournals/joss-reviews#3397

Some functions and methods do not have any descriptions of the arguments in their docstrings, for example

ecological-inference/pyei/two_by_two.py

Lines 27 to 33 in 2d47262

	def truncated_normal_asym(
	group_fraction, votes_fraction, precinct_pops
	): # pylint: disable=too-many-locals
	"""
	A modification of king97's truncated normal that puts some broad priors
	over the parameters of the truncated normal dist
	"""

ecological-inference/pyei/two_by_two.py

Lines 219 to 222 in 2d47262

	def log_binom_sum(lower, upper, obs_vote, n0_curr, n1_curr, b_1_curr, b_2_curr, prev):
	"""
	Helper function for computing log prob of convolution of binomial
	"""

ecological-inference/pyei/two_by_two.py

Lines 277 to 279 in 2d47262

	def wakefield_model_beta(
	group_fraction, votes_fraction, precinct_pops, pareto_scale=8, pareto_shape=2
	):

ecological-inference/pyei/two_by_two.py

Lines 326 to 333 in 2d47262

	def wakefield_normal(group_fraction, votes_fraction, precinct_pops, mu0=0, mu1=0):
	"""
	2 x 2 EI model Wakefield with normal hyperpriors
	Note: Wakefield suggests adding another level of hierarchy, with a prior over mu0 and mu1,
	sigma0, sigma1, but that is not yet implemented here
	"""

ecological-inference/pyei/two_by_two.py

Line 382 in 2d47262

def __init__(self, model_name, **additional_model_params):

ecological-inference/pyei/two_by_two.py

Lines 548 to 551 in 2d47262

	def plot_polarization_kde(
	self, threshold=None, percentile=None, reference_group=0, show_threshold=False, ax=None
	):
	"""Plot kde of differences between voting preferences"""

ecological-inference/pyei/goodmans_er.py

Line 21 in 2d47262

def __init__(self, is_weighted_regression=False):

ecological-inference/pyei/goodmans_er.py

Line 116 in 2d47262

def __init__(self, model_name, weighted_by_pop=False, **additional_model_params):

ecological-inference/pyei/r_by_c.py

Line 135 in 2d47262

def __init__(self, model_name, **additional_model_params):

If any of the (non-__init__) functions / methods are intended for internal use only it may be worth indicating that by prefixing the names with an underscore and/or explicitly declaring the public API of each module in the __all__ attribute.

[matt-graham]

Docstrings updated in c9acc2e so closing.