davebshow / goblin

A Python 3.5 rewrite of the TinkerPop 3 OGM Goblin
Other
93 stars 21 forks source link

Code style and docs references #90

Closed jirikuncar closed 6 years ago

jirikuncar commented 6 years ago

depends on https://github.com/davebshow/aiogremlin/issues/9

jirikuncar commented 6 years ago

@davebshow I have enabled doctests and pycodestyle checks. In the future it would be nice to add pydocstyle and strict documentation build after the davebshow/aiogremlin#9 is resolved.

davebshow commented 6 years ago

That is fine with me, overall this looks pretty good. Could you please add documentation about how to build project/docs. Maybe a contributing section...

jirikuncar commented 6 years ago

@davebshow I will have way bigger PR just for documentation later. For now I have fixed your other comments.

davebshow commented 6 years ago

I'm a bit slammed today. Will finish review first thing tomorrow.

jirikuncar commented 6 years ago

@davebshow in order to get good results when building documentation it would be nice to merge https://github.com/davebshow/aiogremlin/pull/10 first.

jirikuncar commented 6 years ago

Also please let me know if you have any preference for isort and yapf configuration. I try to keep both tools with almost default configuration not to force my personal preferences.

davebshow commented 6 years ago

Let's just change the isort preference to hanging grid, and after we merge #10 for aiogremlin I will merge this.

jirikuncar commented 6 years ago

@davebshow I have changed the .editorconfig and reformatted the imports.

jirikuncar commented 6 years ago

@davebshow did you have time to look into it?

davebshow commented 6 years ago

Hey @jirikuncar, didn't realize you had made these changes. Thanks!