Improve “scanability” of API change docs (#13)

This change makes it easier to scan and find information in each section of the API documentation by bringing any information that is outside of a table to the top of the section.
OpenFAST · Mar 10, 2021 · 7b5881f · 7b5881f
1 parent 54f2a62
commit 7b5881f
Showing 1 changed file with 19 additions and 23 deletions.
diff --git a/docs/source/user/api_change.rst b/docs/source/user/api_change.rst
@@ -17,6 +17,14 @@ Many changes were applied to SubDyn input file format. You may consult the follo
 :download:`(SubDyn's Input File) <./subdyn/examples/OC4_Jacket_SD_Input.dat>`: 
 and the online SubDyn documentation.
 
+- ServoDyn
+
+ - The input file parser is updated to a keyword/value pair based input.
+ Each entry must have a corresponding keyword with the same spelling as
+ expected
+ - The TMD submodule of ServoDyn is replaced by an updated Structural Control
+ module (StC) with updated capabilities and input file.
+
 ============================================= ==== =============== ========================================================================================================================================================================================================
 OpenFAST v2.5.0 to OpenFAST dev 
 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -49,16 +57,6 @@ ServoDyn 67 NumSStC 0
 ServoDyn 68 SStCfiles "unused" SStCfiles - Name of the files for substructure structural controllers (quoted strings) [unused when NumSStC==0]
 ============================================= ==== =============== ========================================================================================================================================================================================================
 
-- ServoDyn
-
- - The input file parser is updated to a keyword/value pair based input.
- Each entry must have a corresponding keyword with the same spelling as
- expected
- - The TMD submodule of ServoDyn is replaced by an updated Structural Control
- module (StC) with updated capabilities and input file.
-
-
-
 ============================================= ====== =============== ======================================================================================================================================================================================================
 Modified in OpenFAST dev
 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -119,6 +117,13 @@ HydroDyn 74 PtfmYF True
 OpenFAST v2.4.0 to OpenFAST v2.5.0
 ----------------------------------
 
+- InflowWind
+
+ - The input file parser is updated to a keyword/value pair based input.
+ Each entry must have a corresponding keyword with the same spelling as
+ expected. See :numref:`input_file_overview` for an overview.
+ - Driver code includes ability to convert between wind types
+
 ============== ==== ================== =============================================================================================================================================================================
 Added in OpenFAST v2.5.0
 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -131,17 +136,11 @@ IfW driver 9 WrVTK false WrVTK - Convert all data
 InflowWind 7 VFlowAng 0 VFlowAng - Upflow angle (degrees) (not used for native Bladed format WindType=7)
 ============== ==== ================== =============================================================================================================================================================================
 
-- InflowWind
-
- - The input file parser is updated to a keyword/value pair based input.
- Each entry must have a corresponding keyword with the same spelling as
- expected. See :numref:`input_file_overview` for an overview.
- - Driver code includes ability to convert between wind types
-
-
 OpenFAST v2.3.0 to OpenFAST v2.4.0
 ----------------------------------
 
+Additional nodal output channels added for :ref:`AeroDyn15<AD-Nodal-Outputs>`, :ref:`BeamDyn<BD-Nodal-Outputs>`, and :ref:`ElastoDyn<ED-Nodal-Outputs>`.
+
 ============== ==== ================== =============================================================================================================================================================================
 Added in OpenFAST v2.4.0
 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -162,10 +161,9 @@ AeroDyn 36 OLAFInputFileName "Elliptic_OLAF.dat" OLAFInputFileName
 AirFoilTables 4\* BL_file "unused" BL_file - The file name including the boundary layer characteristics of the profile. Ignored if the aeroacoustic module is not called.
 ============== ==== ================== =============================================================================================================================================================================
 
-Modified in OpenFAST v2.4.0
----------------------------
-
 ============== ==== ================== ======================================================================================================================================================= =========================
+Modified in OpenFAST v2.4.0
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Module Line New Flag Name Example Value Previous Flag Name/Value
 ============== ==== ================== ======================================================================================================================================================= =========================
 AirFoilTables 40\* filtCutOff "DEFAULT" filtCutOff - Reduced frequency cut-off for low-pass filtering the AoA input to UA, as well as the 1st and 2nd deriv (-) [default = 0.5] [default = 20]
@@ -178,8 +176,6 @@ InflowWind 49 XOffset 0 XOffset - Initial offset
 
 \*non-comment line count, excluding lines contained if NumCoords is not 0.
 
-Additional nodal output channels added for :ref:`AeroDyn15<AD-Nodal-Outputs>`,
-:ref:`BeamDyn<BD-Nodal-Outputs>`, and :ref:`ElastoDyn<ED-Nodal-Outputs>`.