Some of the documentation for CLI for Aviary is confusing - Githubissues

OpenMDAO / Aviary

NASA's aircraft analysis, design, and optimization tool

https://openmdao.github.io/Aviary/

Other

134 stars 59 forks source link

Some of the documentation for CLI for Aviary is confusing #308

Open hschilling opened 4 months ago

hschilling commented 4 months ago

Description

Some of the documents show examples of using the command line that will only work in a Jupyter notebook which is confusing for users.

it would be better to do things as is done in OpenMDAO

https://openmdao.org/newdocs/versions/latest/other_useful_docs/om_command.html

Example

See https://openmdao.github.io/Aviary/user_guide/aviary_commands.html

Also notice the unneeded use of back ticks in this example

Aviary Version

0.9.4-dev

Relevant environment information

No response