Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: document ProviderContextManager [APE-618] #1710

Merged
merged 5 commits into from
Oct 31, 2023

Conversation

antazoey
Copy link
Member

What I did

[APE-618] #1297

fixes: #1297
Fixes: APE-618

How I did it

How to verify it

Checklist

  • All changes are completed
  • New test cases have been added
  • Documentation has been updated

@vany365 vany365 changed the title Docs/networks ctx Docs/networks ctx [APE-1481] Oct 30, 2023
@antazoey antazoey changed the title Docs/networks ctx [APE-1481] docs: document ProviderContextManager [APE-1481] Oct 30, 2023
print(provider)
```

**A note about disconnect**: Providers do not disconnect until the very end of your Python session.
Copy link
Member Author

Choose a reason for hiding this comment

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

note: am not against re-designing this as a breaking change but this is how it works today.

We could probably flip it though, like keep_alive=True to keep certain connections from disconnecting and then we can have users do that in their pytest fixtures.

But this is a breaking change; the network disconnect functionality has been around since we were really focused on ape-starknet so I apologize the conflicting use-cases, but I at least want this documented.

fubuloubu
fubuloubu previously approved these changes Oct 31, 2023
@antazoey antazoey merged commit 34aa98c into ApeWorX:main Oct 31, 2023
@antazoey antazoey deleted the docs/networks-ctx branch October 31, 2023 16:23
@vany365 vany365 changed the title docs: document ProviderContextManager [APE-1481] docs: document ProviderContextManager [APE-618] Nov 1, 2023
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.

Documentation is not clear about provider context manager [APE-618]
2 participants