Skip to content

Documentation for patch_all #403

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

Closed
SamStephens opened this issue Sep 18, 2023 · 2 comments
Closed

Documentation for patch_all #403

SamStephens opened this issue Sep 18, 2023 · 2 comments

Comments

@SamStephens
Copy link

There is no documentation of what patch_all actually does, even though it's included in an example in README.md.

This is particularly important due to #100, talking about the potential of surprises from patch_all

Does patch_all patch from a whitelist of known libraries that can be patched. Does it have some magic generic approach to try and patch all modules?

Looking at the code makes it clear patch_all patches from a whitelist, but it would be good for this to be documented.

Also, users of patch have to read code to understand what they can patch with it. Even a short piece of documentation linking into the code would lower the barrier of entry.

@SamStephens
Copy link
Author

I see it's described here, but it'd be good if the API reference linked to that documentation page.

@carolabadeer
Copy link
Contributor

Thanks for the feedback @SamStephens! The PR above adds clarification on the patch functions in the API documentation

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

No branches or pull requests

2 participants