Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: specify empty docstring fields #36

Merged
merged 8 commits into from
Jul 21, 2023
Merged

docs: specify empty docstring fields #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
da57e17
Update delta.py
benwandrew Jul 17, 2023
32025fe
docs: fix line length
benwandrew Jul 17, 2023
c6f2ac2
docs: remove trailing white space
benwandrew Jul 17, 2023
0966a7f
docs: add content to Returns field in docstring for _merge_dicts
benwandrew Jul 17, 2023
1ae63c8
docs: docstring formatting
benwandrew Jul 17, 2023
626990a
Update src/autora/state/delta.py
benwandrew Jul 18, 2023
efc2929
Update src/autora/state/delta.py
benwandrew Jul 18, 2023
73c2b5e
docs: remove white space
benwandrew Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/autora/experimentalist/pipeline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ def _merge_dicts(a: dict, b: dict):
a: the "base" dictionary
b: the "update" dictionary which takes precendence

Returns:
Returns: the combined dictionary

Originally from https://stackoverflow.com/a/7205107, modified for AER to allow overwriting.

Expand Down
5 changes: 3 additions & 2 deletions src/autora/state/delta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,10 @@ def wrap_to_use_state(f):
It was inspired by the pytest "fixtures" mechanism.

Args:
f:
f: a function with arguments that could be fields on a `State`
and that returns a `Delta`.

Returns:
Returns: a version of `f` which takes and returns `State` objects.

Examples:
>>> from autora.state.delta import State, Delta
Expand Down