Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Chore cargo docs #416

Merged
merged 14 commits into from
Aug 15, 2023
Merged

Chore cargo docs #416

merged 14 commits into from
Aug 15, 2023

Conversation

Autoparallel
Copy link
Collaborator

@Autoparallel Autoparallel commented Aug 15, 2023

Purpose

Clean up arbiter-core and Cargo docs.


Tasks Completed

  • Added Cargo docs to each module inside of arbiter-core except for bindings. We should consider adding documentation there, but make sure we prevent overwrites in some way.
  • Merged in a removal of any and all agents and had this reflected in the documentation.
  • Fixed any bugs or missing implementations with custom errors, and made their names more idiomatic (i.e., removed Error from the enum variants.
  • Had all of the revm logs cast into ethers logs done in middleware module and made revm_logs_to_ethers_logs() private.
  • Reduced visibility of a handful of structs, enums, and functions/methods.

@Autoparallel Autoparallel requested a review from 0xJepsen August 15, 2023 17:43
@Autoparallel Autoparallel added the 🚧 WIP 🚧 DO NOT MERGE THIS PR label Aug 15, 2023
Copy link
Collaborator

@0xJepsen 0xJepsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks really clean to me! We got to remember to add the link for the other docs later

@Autoparallel Autoparallel removed the 🚧 WIP 🚧 DO NOT MERGE THIS PR label Aug 15, 2023
@0xJepsen 0xJepsen merged commit 2443e80 into feat/middleware Aug 15, 2023
@0xJepsen 0xJepsen deleted the chore-cargo-docs branch August 16, 2023 21:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants