Open AFg6K7h4fhy2 opened 4 months ago
I like this suggestion, and in general I like using named arguments for code readability even internally.
We have moved toward doing this both in code and tutorials. @AFg6K7h4fhy2 would you be willing to add a note to the developer docs recommending this?
Given the variety of backgrounds and experiences present across CFA and the fact that CFA members seem, at present time, to constitute most of MSRs early users, I suggest we explicitly write out the argument names for positional arguments.
Pro: The argument names provide useful information to new users of MSR, Python, and certain Python package (e.g.,
numpyro
).Con: Blurs the lines between required and optional arguments, as now all previously positional arguments are presented as keyword arguments.
Con: More writing for MSR developers.
Examples
...would change to
Further thoughts are welcome. I do not feel particularly strongly about this, I just believe it might help clarify things to people in the tutorials somewhat.