Skip to content

Commit

Permalink
doc: improve comment on show() method
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed Apr 9, 2024
1 parent 7e4dad4 commit 72e8b4a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/pylifemap/lifemap.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,9 @@ def show(self) -> None:
"""
Display the Jupyter widget for this instance.
If we are in a notebook environment, use `display`. Otherwise, export widget to
an HTML file and open it in a browser if possible.
In a notebook environment, the method uses `IPython.display.display` to display
the visualization directly. Otherwise, it exports the widget to an HTML file and
opens it in a browser if possible.
"""
if is_notebook():
display(self._to_widget())
Expand Down

0 comments on commit 72e8b4a

Please sign in to comment.