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

Refactoring and documentation #42

Open
reiniervlinschoten opened this issue May 5, 2024 · 1 comment
Open

Refactoring and documentation #42

reiniervlinschoten opened this issue May 5, 2024 · 1 comment

Comments

@reiniervlinschoten
Copy link
Collaborator

The package is currently quite cluttered.
Some functions need to retrieve data from several API endpoints (e.g. getStudyData).
Currently this is done in the function body.
However this way other functions need to implement these calls themselves.
The package should be refactored to create special functions, and maybe save returned objects, so all functions can use this information.
This would also make the easier to develop.

The same goes for documentation.
All functions should have a docstring and comments indicating what exactly is happening.
This way, we can also create an overview of which functions there are in the package.
And move functions that are for internal use only to private.

@reiniervlinschoten
Copy link
Collaborator Author

In #51 I have started working on adding tests, please see the PR for what needs to be done
In #52 I have started working on making the tests for getStudyDataPoints pass, please see the PR for what needs to be done.

After these 2 PRs, we need to make sure all tests changed and updated in #51 pass.
All tests and code changes should work toward making sure output of the functions matches: tests/test_files/files_output

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

1 participant