frost icon indicating copy to clipboard operation
frost copied to clipboard

[docs] update file layout & usage section

Open hwine opened this issue 4 years ago • 2 comments

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 https://github.com/mozilla/frost/pull/436#discussion_r562192928

hwine avatar Jan 21 '21 20:01 hwine

Current docs:

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

hwine avatar Jan 21 '21 21:01 hwine

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

ajvb avatar Jan 22 '21 18:01 ajvb