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

Test docu: Missing docu about test_packags.py and processPackage() #758

Open
buhtz opened this issue Jan 1, 2024 · 0 comments
Open

Test docu: Missing docu about test_packags.py and processPackage() #758

buhtz opened this issue Jan 1, 2024 · 0 comments

Comments

@buhtz
Copy link
Contributor

buhtz commented Jan 1, 2024

Just an example while I was investigating failing unit test in context of PR #722.

def processPackage(packname: str, systemcls: Callable[[], model.System] = model.System) -> model.System:

This is not a support question. I would like to have a in code docu.
What is unclear to me:

  • What is the purpose of the file test_packages.py? Might it be helper code in context of unit tests or are these tests? Or is this one of the pytest specific features I don't know about? A module doc string would help to clear this up.
  • The purpose of processPackage() is also unclear. A docstring would help.
  • The function docstring problem is also relevant for all other functions in this file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants