Skip to content

Example script mixes up STK Desktop and STK Engine #952

@pdouglass7

Description

@pdouglass7

Description of the modifications

This page guides a user to starting an instance of STK Engine:
https://stk.docs.pyansys.com/version/stable/examples/create-load-scenarios.html

The description underneath the first code block states:
"This creates an instance of the STK application. Setting no_graphics to False opens the STK window."

This isn't true, since STK Engine will never open an STK window. It appears to be mixing that input up with the STKDesktop class which has the visible input to start_application which does control whether an application window opens.

It may be beneficial to users to point them to the conversation about no_graphics on the programming help:
https://help.agi.com/stkdevkit/index.htm#stkEngine/NoGraphics.htm

Useful links and references

https://stk.docs.pyansys.com/version/stable/examples/create-load-scenarios.html
https://help.agi.com/stkdevkit/index.htm#stkEngine/NoGraphics.htm

Metadata

Metadata

Labels

bugDefects or glitches reported by users or developersdocs:examplesRelated to documentation examples

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions