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 #299

Closed jschalk closed 2 months ago

jschalk commented 2 months ago

Summary by Sourcery

Refactor codebase by renaming attributes 'open' and 'nigh' to 'fopen' and 'fnigh' for improved clarity. Update all relevant functions, methods, and test cases to accommodate these changes.

Enhancements:

Tests:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request implements a significant refactoring of the codebase, primarily focusing on renaming attributes related to fact units. The main changes involve renaming 'open' to 'fopen' and 'nigh' to 'fnigh' across multiple files and classes. This change appears to be part of a larger effort to improve code clarity and consistency.

File-Level Changes

Change Details Files
Renamed 'open' attribute to 'fopen' and 'nigh' attribute to 'fnigh' in fact-related classes and functions
  • Updated FactCore class attributes and methods
  • Modified FactUnit and FactHeir classes to use new attribute names
  • Updated related test cases to use new attribute names
  • Changed JSON representations to use new attribute names
  • Modified SQL-related code to use new column names
src/bud/reason_idea.py
src/bud/test_/test_fact.py
src/bud/test_/test_premise_.py
src/bud/idea.py
src/bud/bud.py
src/gift/legible.py
src/gift/change.py
src/gift/atom_config.py
src/gift/atom.py
src/normal_db/normal_models.py
src/bud/examples/example_bud1.json
src/bud/examples/example_bud2.json
src/gift/atom_config.json
Updated function signatures and method calls to use new attribute names
  • Modified set_fact method to use fopen and fnigh
  • Updated get_dict method in FactCore class
  • Changed transform method in FactHeir class
  • Adjusted test cases to use new attribute names in assertions
src/bud/bud.py
src/bud/test_bud/test_bud_set_fact.py
src/bud/test_bud_settle/test_tree_traverse_z_fact.py
src/bud/test_bud_settle/test_z_agenda.py
Refactored SQL-related code to use new column names
  • Updated SQL queries and table definitions
  • Modified AtomUnit class to use new attribute names in SQL-related methods
  • Adjusted test cases for SQL-related functionality
src/real/test_real_/test_journal_sqlstr_.py
src/gift/test_atom/test_atom_sql.py
src/normal_db/normal_models.py
Updated JSON representations to use new attribute names
  • Modified JSON examples to use fopen and fnigh
  • Updated methods that generate or parse JSON to use new attribute names
src/bud/examples/example_bud1.json
src/bud/examples/example_bud2.json
src/bud/test_bud/test_bud_json.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.