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

Improve Print Outputs #5

Merged
merged 6 commits into from
Mar 3, 2024
Merged

Improve Print Outputs #5

merged 6 commits into from
Mar 3, 2024

Conversation

mdapena
Copy link
Member

@mdapena mdapena commented Mar 2, 2024

Initial Checks

  • The code compiles successfully without any errors or warnings.
  • I have personally tested these changes on my local environment.
  • I have ensured that relevant documentation has been added or updated.
  • I adhere to the project structure and code standards defined in the documentation.
  • My code follows the established coding style guidelines.
  • I have added tests for the new code (if applicable).
  • All existing tests have passed successfully.

Description

This PR enhances the print outputs of the Model and Term classes, improves the visibility of badges, and updates the configuration of the git-committers plugin for consistency.

  • The print_info and print_solution methods in the Model class have been enhanced to improve visibility and provide deeper insights.
  • The get_pretty_string method in the Term class has been refactored as an @abstractmethod for subclass customization.
  • Badges on the main page of the documentation and the readme file have been updated to improve visibility and align with the package's color palette.
  • The git-committers plugin in the mkdocs.yml file has been updated to exclude the index.md, examples/index.md, and api/index.md files for consistency in the current configuration with the git-revision-date-localized plugin.

@mdapena mdapena added documentation Improvements or additions to documentation enhancement Suggests an improvement or enhancement to an existing feature labels Mar 2, 2024
@mdapena mdapena requested a review from idapena March 2, 2024 23:57
@mdapena mdapena assigned mdapena and unassigned mdapena Mar 2, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8126231279

Details

  • 3 of 3 (100.0%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 8125264583: 0.0%
Covered Lines: 2611
Relevant Lines: 2611

💛 - Coveralls

@idapena idapena merged commit 0b9b5c7 into master Mar 3, 2024
8 checks passed
@mdapena mdapena deleted the improve-print-outputs branch March 3, 2024 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Suggests an improvement or enhancement to an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants