Skip to content

feat: add docs - #81

Merged
fubuloubu merged 12 commits into
mainfrom
feat/add-docs
Jul 16, 2025
Merged

feat: add docs#81
fubuloubu merged 12 commits into
mainfrom
feat/add-docs

Conversation

@fubuloubu

Copy link
Copy Markdown
Member

What I did

Adds comprehensive documentation for plugin
Adds .create_batch to SafeAccount

fixes: #49

How I did it

How to verify it

Checklist

  • Passes all linting checks (pre-commit and CI jobs)
  • New test cases have been added and are passing
  • Documentation has been updated
  • PR title follows Conventional Commit standard (will be automatically included in the changelog)

banteg and others added 5 commits July 15, 2025 12:09
- Create detailed documentation to replace outdated docs
- Add new documentation structure with separate guides for each topic
- Add CLI reference with all available commands
- Add API reference with key classes and methods
- Update README with links to new documentation
- Fix examples to use correct Ape patterns and ape-tokens plugin

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
@fubuloubu
fubuloubu requested a review from antazoey July 15, 2025 19:52
@fubuloubu
fubuloubu merged commit c9a71e4 into main Jul 16, 2025
29 checks passed
@fubuloubu
fubuloubu deleted the feat/add-docs branch July 16, 2025 21:57

@antazoey antazoey left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I know it already merged, but added review anyway!

Comment thread ape_safe/accounts.py
ms.add(contract2.method2)

# raises `ape.exceptions.TransactionError`
ms()

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

could put in try/except handling TransactionError

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Meant this to demonstrate how you might handle a scenario where it raises

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

wouldnt it raise and not reach the next line? or is this assuming repl environment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

oh, you mean for doc testing?


The Safe protocol supports configuring "Modules", which are contracts that have special capabilities to access your Safe.

You can enable or disable modules using the Safe contract as followsnot :

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

followsnot? typo

Comment thread setup.py
submitter = accounts.load("my-account")

# Find and execute a transaction that has enough signatures
for tx, confirmations in safe.pending_transactions():

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is there a way to just get the tx by nonce directly?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

not pending ones, that's a good suggestion to add

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish docs for current usage

3 participants