Skip to content

Commit 18ccbfb

Browse files
committed
doc: update stale doc about sdat.par
1 parent edc44f8 commit 18ccbfb

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/sources/stagyydata.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,10 @@ Parameters file
7777

7878
Parameters set in the ``par`` file are accessible through the
7979
:attr:`~stagpy.stagyydata.StagyyData.par` attribute of a
80-
:class:`~stagpy.stagyydata.StagyyData` instance. ``sdat.par`` is organized as
81-
a dictionary of dictionaries. For example, to access the Rayleigh number from
80+
:class:`~stagpy.stagyydata.StagyyData` instance.
81+
For example, to access the Rayleigh number from
8282
the ``refstate`` section of the par file, one can use
83-
``sdat.par['refstate']['ra0']``. Parameters that are not set in the par file
84-
are given a default value.
83+
``sdat.par.nml['refstate']['ra0']``.
8584

8685
Radial profiles
8786
---------------

0 commit comments

Comments
 (0)