Skip to content

Commit

Permalink
Merge pull request #995 from slaclab/gui-doc
Browse files Browse the repository at this point in the history
Document removal of legacy GUI
  • Loading branch information
ruck314 authored Mar 27, 2024
2 parents eda4964 + c7d3065 commit ae85473
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/src/migration/rogue_v6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,30 @@ The reasoning is that a lot happens behind the scences when changing a
poll interval, and masking this with a setter decorator gives the user
the impression that it is much simpler than it is.

Previously Deprecated Legacy GUI has Been Removed
=================================================

The legacy GUI has been removed. You can no longer use the following
code to launch a generic tree GUI.

.. code::
import pyrogue.gui
with Root(...) as root:
appTop = pyrogue.gui.application(sys.argv)
guiTop = pyrogue.gui.GuiTop()
guiTop.addTree(root)
guiTop.resize(800, 800)
appTop.exec_()
Instead, use the new PyDM GUI

.. code::
import pyrogue.pydm
with Root(...) as root:
pyrogue.pydm.runPyDM(
serverList=root.zmqServer.address,
title='GUI Window Title')

0 comments on commit ae85473

Please sign in to comment.