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.

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

[docs] update file layout & usage section #437

Open
hwine opened this issue Jan 21, 2021 · 2 comments
Open

[docs] update file layout & usage section #437

hwine opened this issue Jan 21, 2021 · 2 comments

Comments

@hwine
Copy link
Contributor

hwine commented Jan 21, 2021

Roughly (my interpretation):

  • __init__.py is just to mark directory as a package
  • client.py has all the code related to communication with the service
  • helpers.py has all the code related to simplifying tests (e.g. operations on data structures returned from service)

But I see that differs a bit from the design docs.

Again, this isn't a blocker for this commit, but it does look like the design & file layout needs a refresh. I'll open a separate issue.

Originally posted by @hwine in #436 (comment)

@hwine
Copy link
Contributor Author

hwine commented Jan 21, 2021

Current docs:

  • don't define purpose of client.py
  • don't mention usage of __init__.py
  • don't show nested conftest.py files

@ajvb
Copy link
Contributor

ajvb commented Jan 22, 2021

From #436 - I'd agree with the assumption you stated about "client.py has all the code related to communication with the service".

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

No branches or pull requests

2 participants