175 enable documentation process

Reviewer's Guide by Sourcery

This pull request implements a consistent naming change across the codebase, renaming variables and parameters from 'required_args'/'optional_args' to 'jkeys'/'jvalues' and 'eon_id' to 'event_id'. The changes aim to improve code clarity and maintain consistent terminology.

Class diagram for updated parameter naming

classDiagram
    class AtomUnit {
        - jkeys: str
        - jvalues: str
        + is_jkeys_valid(): bool
        + is_jvalues_valid(): bool
    }
    class DeltaUnit {
        + add_atomunit(category: str, crud_str: str, jkeys: str, jvalues: str)
        + get_atomunit(crud_str: str, category: str, jkeys: list[str]): AtomUnit
    }
    class BudUnit {
        + add_acctunit(acct_id: str)
        + get_acct(acct_id: str)
    }
    class Membership {
        + credit_vote: int
        + debtit_vote: int
    }
    AtomUnit --> DeltaUnit
    DeltaUnit --> BudUnit
    BudUnit --> Membership
    note for AtomUnit "Renamed parameters from 'required_args'/'optional_args' to 'jkeys'/'jvalues'"
    note for DeltaUnit "Updated methods to use 'jkeys' and 'jvalues'"

File-Level Changes

Change	Details	Files
Renamed 'required_args' and 'optional_args' to 'jkeys' and 'jvalues' respectively throughout the codebase	Updated AtomUnit class attributes and methods to use new naming Modified configuration files (atom_config.json, brick_config.json, etc.) to use new parameter names Updated all test files to use new parameter names Renamed related helper functions and string constants	`src/f04_gift/atom.py` `src/f04_gift/atom_config.json` `src/f04_gift/atom_config.py` `src/f04_gift/test_atom/test_atom_core.py` `src/f04_gift/test_atom/test_atom_config.py`
Renamed 'eon_id' to 'event_id' across the entire codebase	Updated database models and schemas Modified brick format configuration files Updated test files and examples to use new naming Changed related function names and string constants	`src/f09_brick/brick_models.py` `src/f09_brick/brick_formats/.json` `src/f08_pidgin/pidgin.py` `src/f10_world/test/test_world_.py`

Possibly linked issues

#175: The PR enables the documentation process, directly addressing the issue's requirement to create documentation.

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

jschalk / jaar