Skip to content
This repository has been archived by the owner on Nov 10, 2018. It is now read-only.

docstring conform to PEP 484 #30

Merged
merged 2 commits into from
Aug 18, 2015
Merged

Conversation

carocad
Copy link
Contributor

@carocad carocad commented Jul 1, 2015

Hey Aki,
I changed the old docstrings to conform to the new PEP. You should beware that since there was no fast way to contact you, most of the time I worked under my best assumption of the type of variable that you were expecting. This is specially strong on the dicts, where most of the type there were nested types which makes it difficult to keep track of them :/

Hope it helps

@@ -136,7 +144,7 @@ def get_config(name="root"):
of name `name`.

Returns:
config (dict): By default scriptharness.structures.LoggingDict
config (Dict[str, str]): By default scriptharness.structures.LoggingDict
Copy link
Contributor

Choose a reason for hiding this comment

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

config doesn't have to have str values; they can be dicts, lists, strs, ints... maybe 'object' or 'various' or something?

Ah, looks like 'Any'.

@escapewindow
Copy link
Contributor

Thank you, @carocad. I don't think any of the above comments strictly block, though a couple could be improved. The main concern I have is that we need to resolve conflicts before merging; could you address that?

@carocad
Copy link
Contributor Author

carocad commented Aug 18, 2015

Hey Aki,
Sorry for the huge delay. I solved the merge conflict so it should be working now.

I hope it helps ;)

escapewindow added a commit that referenced this pull request Aug 18, 2015
docstring conform to PEP 484
@escapewindow escapewindow merged commit 398b0dd into scriptharness:master Aug 18, 2015
@escapewindow
Copy link
Contributor

Thank you Camilo!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants