Skip to content

Commit

Permalink
Correct doc comment about not being able to remove plugin repositorie…
Browse files Browse the repository at this point in the history
…s; Also add doc comment for #2987
  • Loading branch information
ElykDeer committed Jun 12, 2024
1 parent 037d3c2 commit 580b843
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions python/pluginmanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,9 +386,10 @@ def add_repository(self, url: Optional[str] = None, repopath: Optional[str] = No
"""
``add_repository`` adds a new plugin repository for the manager to track.
There is currently no function to remove a repository. If you want to
remove a repository, you must delete the directory and remove the
plugin_status.json entries from repositories/ file in the User Folder
To remove a repository, restart Binary Ninja (and don't re-add the repository!).
File artifacts will remain on disk under repositories/ file in the User Folder.
Before you can query plugin metadata from a repository, you need to call ``check_for_updates``.
:param str url: URL to the plugins.json containing the records for this repository
:param str repopath: path to where the repository will be stored on disk locally
Expand All @@ -399,6 +400,7 @@ def add_repository(self, url: Optional[str] = None, repopath: Optional[str] = No
>>> mgr = RepositoryManager()
>>> mgr.add_repository("https://raw.githubusercontent.com/Vector35/community-plugins/master/plugins.json", "community")
True
>>> mgr.check_for_updates()
>>>
"""
if not isinstance(url, str) or not isinstance(repopath, str):
Expand Down

0 comments on commit 580b843

Please sign in to comment.