diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-05-31 11:34:35 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-05-31 11:34:35 -0400 |
| commit | d03f3e58fcdd548c788eeff51d7507e07ed799ed (patch) | |
| tree | bc7a726e1665383d50fe7a14ae0b2fe83edfe7db /python | |
| parent | 55a03e715ec62f7f85cfd57db6351a6efb626d7a (diff) | |
fixup invalid pydoc documentation
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 4 | ||||
| -rw-r--r-- | python/enterprise.py | 2 |
2 files changed, 6 insertions, 0 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 966c164b..fdd03f37 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -4893,6 +4893,7 @@ class BinaryView: def get_tag_type(self, name: str) -> Optional['TagType']: """ Get a tag type by its name. Shorthand for get_tag_type_by_name() + :param name: Name of the tag type :return: The relevant tag type, if it exists :rtype: TagType @@ -4902,6 +4903,7 @@ class BinaryView: def get_tag_type_by_name(self, name: str) -> Optional['TagType']: """ Get a tag type by its name + :param name: Name of the tag type :return: The relevant tag type, if it exists :rtype: TagType @@ -4914,6 +4916,7 @@ class BinaryView: def get_tag_type_by_id(self, id: str) -> Optional['TagType']: """ Get a tag type by its id + :param id: Id of the tag type :return: The relevant tag type, if it exists :rtype: TagType @@ -4957,6 +4960,7 @@ class BinaryView: def get_tag(self, id: str) -> Optional['Tag']: """ Get a tag by its id. Note this does not tell you anything about where it is used. + :param id: Tag id :return: The relevant tag, if it exists :rtype: Tag diff --git a/python/enterprise.py b/python/enterprise.py index 731ba46b..d1e74011 100644 --- a/python/enterprise.py +++ b/python/enterprise.py @@ -35,6 +35,7 @@ def is_connected() -> bool: def authenticate_with_credentials(username: str, password: str, remember: bool = True): """ Authenticate to the Enterprise Server with username/password credentials. + :param str username: Username to use. :param str password: Password to use. :param bool remember: Remember token in keychain @@ -50,6 +51,7 @@ def authenticate_with_method(method: str, remember: bool = True): Authenticate to the Enterprise Server with a non-password method. Note that many of these will open a URL for a browser-based login prompt, which may not be usable on headless installations. See :func:`authentication_methods` for a list of accepted methods. + :param str method: Name of method to use. :param bool remember: Remember token in keychain """ |