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

Correct and update the Makefile #41

Closed
sugatoray opened this issue May 31, 2022 · 0 comments · Fixed by #40
Closed

Correct and update the Makefile #41

sugatoray opened this issue May 31, 2022 · 0 comments · Fixed by #40

Comments

@sugatoray
Copy link
Contributor

The Makefile has a few problems, and also it is not well documented and well organized. If properly worked on, it could simplify a lot of steps.

  1. .PHONY declarations are either nonexistent or the commands that should have been updated, are not there.
  2. Parametrization of the make commands with variables could lead to lesser human-error. This will require some reorganization.
  3. Add make commands that can directly run several steps such as flake, black, type, clean, etc.
  4. Add doctest checker interrogate to the workflow. For now set the requirement at 0% to pass interrogate runs.
  5. Add documentation to various sections to clearly explain what they are for.
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

Successfully merging a pull request may close this issue.

1 participant