diff options
| author |  Roelof Groenewald <40245517+roelof-groenewald@users.noreply.github.com>
| 2022-08-28 23:28:07 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-08-28 23:28:07 -0700 |
| commit | 052fde57cdf88bae83e5f5943eaeb845a73bbc35 (patch) | |
| tree | 7fd01e0b411c71a4e06f870dc0dd7905f45ee50d /Python/pywarpx/callbacks.py | |
| parent | 48c1a86047fb06b957474c5a92d15f104c77b039 (diff) | |
| download | WarpX-052fde57cdf88bae83e5f5943eaeb845a73bbc35.tar.gz WarpX-052fde57cdf88bae83e5f5943eaeb845a73bbc35.tar.zst WarpX-052fde57cdf88bae83e5f5943eaeb845a73bbc35.zip | |
Docs: Add description of Python APIs in `libwarpx` (#3310)
* add mention of callbacks and some libwarpx functions to the docs
* reformatted various function docstrings in `_libwarpx.py` and added them to the docs
* Add subsection
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Diffstat (limited to 'Python/pywarpx/callbacks.py')
| -rw-r--r-- | Python/pywarpx/callbacks.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Python/pywarpx/callbacks.py b/Python/pywarpx/callbacks.py index e9f034a36..ba13ef439 100644 --- a/Python/pywarpx/callbacks.py +++ b/Python/pywarpx/callbacks.py @@ -71,12 +71,12 @@ class CallbackFunctions(object): Note that for functions passed in that are methods of a class instance, a full reference of the instance is saved. This extra reference means - that the object will not actually deleted if the user deletes the + that the object will not actually be deleted if the user deletes the original reference. This is good since the user does not need to keep the reference to the object (for example it can be created using a local variable in a function). It may be bad if the user thinks an object was deleted, but it actually isn't since it had (unkown to the user) - installed a method in one of the call back lists + installed a method in one of the call back lists. """ def __init__(self,name=None,lcallonce=0): |