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

Documentation update and dev tools suggestions #46

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

eduardo-mw
Copy link
Contributor

@eduardo-mw eduardo-mw commented Oct 30, 2024

The following PR has 2 parts to it.

  1. Additional documentation for public-facing methods and modules. I noticed there aren't many docstrings, so I just used the numpydoc format, which is good for in-depth documentation and is well supported by other tools like Sphinx.
  2. Dev tools suggestions. There also didn't seem to be a preferred choice of linter, formatter, or dependency management tool. In my PR I propose ["pip-tools", "pylint", "black", "python-dotenv", "isort"] as these tools are fairly lightweight, integrate with existing workflow, play nice with each other, and have widespread support. I generated an example of what pip tools can offer with dev-requirements.txt.

@eduardo-mw eduardo-mw changed the title Documentation update Documentation update and dev tools suggestions Oct 30, 2024
@eduardo-mw eduardo-mw requested a review from sanjoyment October 30, 2024 23:02
@bhogayatakb bhogayatakb requested a review from arjun-mw November 4, 2024 12:32
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 this pull request may close these issues.

3 participants