jschalk / jaar

Cross-cultural communication engine built on customizable economic systems. Produces personalized agendas, calendars, finance reports for users.
0 stars 1 forks source link

175 enable documentation process #293

Closed jschalk closed 1 month ago

jschalk commented 1 month ago

Summary by Sourcery

Enhance the test suite by adding new test cases for file operations and SQLite functions. Refactor function parameter names for improved consistency and readability across the codebase. Update the README.md to include a repository link and adjust the logo placement.

Enhancements:

Documentation:

Tests:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements several changes to improve code organization, enhance test coverage, and update file handling functions. The changes primarily affect test files, database tools, and utility functions across multiple modules.

File-Level Changes

Change Details Files
Reorganized and added new test cases for file operations
  • Added new test cases for save_file and open_file functions
  • Moved existing test cases to improve readability
  • Updated assertions and test setup for file operations
src/_instrument/test/test_file.py
Updated README.md with repository information and badges
  • Added repository URL
  • Removed TODO comments from the main body
  • Moved badge placeholders to the bottom of the file
README.md
Refactored database utility functions and their tests
  • Renamed function parameters for consistency (e.g., int_x to x_int)
  • Reordered functions in the file
  • Added type hints to function parameters
src/_instrument/test/test_db_tool.py
src/_instrument/db_tool.py
Updated utility functions in python.py for improved naming consistency
  • Renamed function parameters (e.g., json_x to x_json)
  • Updated function calls to match new parameter names
src/_instrument/python.py
Updated JSON-related function calls across multiple files
  • Updated function calls to match new parameter names in utility functions
  • Simplified some function calls by removing unnecessary parameter names
src/bud/group.py
src/bud/acct.py
src/bud/test_acct/test__membership.py
src/bud/test_acct/test_acct_dict.py
src/bud/test_bud/test_bud_json.py
Fixed a test function name in span_format_generate_span.py
  • Renamed test_create_span_df_Arg_jaar_format_00003_ideaunit_v0_0_0 to test_create_changeunit_Arg_jaar_format_00003_ideaunit_v0_0_0
src/span/test_span/test_span_format_generate_span.py

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.