Skip to content

Cleanup docstring for Function.add_tag #6683

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Cleanup docstring for Function.add_tag #6683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions python/function.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -834,12 +834,13 @@ def add_tag(
Function.add_tag, you'll create an "address tag". These are good for labeling
specific instructions.

For tagging arbitrary data, consider :py:func:`~binaryninja.binaryview.add_tag`.
For tagging arbitrary data, consider :py:func:`~binaryninja.binaryview.BinaryView.add_tag`.

:param str tag_type_name: The name of the tag type for this Tag
:param str tag_type: The name of the tag type for this Tag
:param str data: additional data for the Tag
:param int addr: address at which to add the tag
:param bool user: Whether or not a user tag
:param bool auto: Whether or not an auto tag
:param Architecture arch: Architecture for the location in which the Tags is located (optional)
:Example:

>>> current_function.add_tag("Important", "I think this is the main function")
Expand Down