Skip to content

Commit

Permalink
updated docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
s-martin committed Dec 26, 2023
1 parent 7520514 commit bf54480
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions documentation/developers/docstring/docstring-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4670,10 +4670,6 @@ you can implement a Factory Pattern using this package. Take a look at volume.py

**Example:** Decorate a function for auto-registering under it's own name::

import jukebox.plugs as plugs
@plugs.register
def func1(param):
pass

**Example:** Decorate a function for auto-registering under a new name::

Expand Down Expand Up @@ -4725,6 +4721,12 @@ The string name of the plugin object for registration
method
1. In case the object is a class instance a bound method to call from the class instance
2. The string name to above object
```python
import jukebox.plugs as plugs
@plugs.register
def func1(param):
pass
```

<a id="jukebox.plugs.PluginPackageClass"></a>

Expand Down

0 comments on commit bf54480

Please sign in to comment.