Describe the solution you'd like
This issue is basically a polishing step on the chained PRs for adding docstrings to the functions module.
- Every non-alias function should have an example
- Every example should use all arguments to that function
- All of functions.py should be google docstyle compatible (no ---- under Examples etc)
- Every reference to an alias should be in a
See Also block
- No use of builtins imports (either use ... syntax or print result==expected)
This is a superset of #1433
Ideally, we add some sort of validation of this into CI but that is probably better as another task since it might require more thought for bespoke linting.
Describe the solution you'd like
This issue is basically a polishing step on the chained PRs for adding docstrings to the functions module.
See AlsoblockThis is a superset of #1433
Ideally, we add some sort of validation of this into CI but that is probably better as another task since it might require more thought for bespoke linting.