Skip to content
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.

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

Doc cleanup #311

Merged
merged 4 commits into from
Jul 28, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions openmdao/core/tests/test_impl_comp.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,8 @@ def solve_nonlinear(self, inputs, outputs):
pass

def guess_nonlinear(self, inputs, outputs, resids):
# Solution at 1 and 3. Default value takes us to -1 solution. Here
# we set it to a value that will tke us to the 3 solution.
# Solution at x=1 and x=3. Default value takes us to the x=1 solution. Here
# we set it to a value that will take us to the x=3 solution.
outputs['x'] = 5.0


Expand Down
8 changes: 4 additions & 4 deletions openmdao/docs/tutorials/first_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Preamble
::

from __future__ import division, print_function
from openmdao.core.explicitcomponent import ExplicitComponent
from openmdao.api import ExplicitComponent

At the top of any script you'll see these lines (or lines very similar to these) which import needed classes and functions. On the first import line the `print_function` is used so the code in the script will work in python 2.0 or 3.0. If you want to know whats going on with the division operator, check out this `detailed explanation <https://www.python.org/dev/peps/pep-0238/>`_. The second import line brings in OpenMDAO classes that are needed to build and run a model.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this isn't part of your PR, but we should change python 2.0 and python 3.0 to either python 2 and python 3 or python 2.x and python 3.x.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also I think Python should be capitalized ;)

As you progress to more complex models you can expect to import more classes from `openmdao.api`, but for now we only need these 4.
Expand Down Expand Up @@ -87,9 +87,9 @@ You can read more about how OpenMDAO handles units and scaling here[LINK TO FEAT
.. code::

if __name__ == "__main__":
from openmdao.core.problem import Problem
from openmdao.core.group import Group
from openmdao.core.indepvarcomp import IndepVarComp
from openmdao.api import Problem
from openmdao.api import Group
from openmdao.api import IndepVarComp

model = Group()
ivc = IndepVarComp()
Expand Down