Skip to content

Feature/docstrings #88

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.

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

Merged
merged 10 commits into from
Sep 14, 2021
Merged

Feature/docstrings #88

merged 10 commits into from
Sep 14, 2021

Conversation

euanwm
Copy link
Member

@euanwm euanwm commented Sep 1, 2021

Added docstrings to all valid functions within Eva.py

Fixes #77

There was also a very minor bug within control_resume() where it was waiting for the wrong state.

Copy link
Contributor

@LouisBrunner LouisBrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice initiative, lots of good stuff in there, especially the examples, however a lot of the description aren't really readable English and use confusing language (e.g. every single control_ endpoint use a different phrasing even though they all do nearly the same thing)

I commented on most of the issues but this need a few iterations of polishing the descriptions

@LouisBrunner LouisBrunner requested review from tallpress and LouisBrunner and removed request for LouisBrunner September 9, 2021 11:08
Copy link
Contributor

@tallpress tallpress left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit: very nice

@LouisBrunner LouisBrunner dismissed their stale review September 14, 2021 15:13

Tom reviewed

@tallpress tallpress merged commit 184a61e into automata-tech:development Sep 14, 2021
@euanwm euanwm deleted the feature/docstrings branch September 14, 2021 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docstrings and typing to all functions
3 participants