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

Refactored Code and Improved Documentation #134

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Mike014
Copy link

@Mike014 Mike014 commented Jan 8, 2025

This Pull Request includes the following improvements:

  1. Refactoring:

    • Code refactored for better readability and compliance with PEP8 standards.
    • Fixed issues detected by pylint (e.g., unused variables, undefined loop variables).
  2. Documentation:

    • Updated README.md with comprehensive details about the project's configuration, structure, and usage.
  3. Testing:

    • Updated tox.ini to include isort and black checks.
    • Successfully ran tests with tox:
      • 198 tests passed, 7 skipped, 8 warnings in 535.68 seconds.

Please review the changes, and let me know if any adjustments are needed.

… code with Black, and cleaned up imports using isort.
- Standardized the code using black and isort.
- Fixed issues detected by pylint.
- Enhanced documentation generated with Sphinx (added Introduction, Design, ELiDE, and core modules).
- Ran tests with tox:
  - 198 passed, 7 skipped, 8 warnings in 535.68 seconds.
  - py312: OK (579.72 seconds).
- Updated the following files:
  - eqversion.py
  - main.py
  - setup.py
  - tox.ini
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.

1 participant