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

Fix comments and docstrings in formal_integral.py #1709

Open
2 tasks
KevinCawley opened this issue Jul 13, 2021 · 0 comments
Open
2 tasks

Fix comments and docstrings in formal_integral.py #1709

KevinCawley opened this issue Jul 13, 2021 · 0 comments

Comments

@KevinCawley
Copy link
Contributor

KevinCawley commented Jul 13, 2021

Describe the bug
The docstrings and comments in the formal integral are bad. They do not follow the TARDIS guide to docstrings as of right now. There are several styles being displayed, along with incorrect information in the docstrings in regard to parameters and return types. Some comments also mention c code/extensions, which is outdated.

Variable names should be improved for comprehension to follow PEP8 and the TARDIS codestyle.
To Reproduce
See docstrings in the montecarlo/montecarlo_numba/formal_integral.py

Screenshots

System

  • OS:

    • GNU/Linux
    • macOS
  • Environment (conda list):
    tardis

Additional context

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

1 participant