Numerous minor tweaks to source for legacy Sphinx docs.

lib/apply_changes.m

@@ -1,5 +1,5 @@
 function mpc = apply_changes(label, mpc, chgtab)
-% apply_changes - Applies a set of changes to a MATPOWER case
+% apply_changes - Applies a set of changes to a |MATPOWER| case
 % ::
 %
 %   mpc_modified = apply_changes(label, mpc_original, chgtab)

lib/caseformat.m

@@ -1,4 +1,4 @@
-% caseformat - Defines the MATPOWER case file format.
+% caseformat - Defines the |MATPOWER| case file format.
 % ::
 %
 %   A MATPOWER case file is an M-file or MAT-file that defines or returns

lib/cdf2mpc.m

@@ -1,5 +1,5 @@
 function [mpc, warnings] = cdf2mpc(cdf_file_name, mpc_name, verbose)
-% cdf2mpc - Converts an IEEE CDF data file into a MATPOWER case struct.
+% cdf2mpc - Converts an IEEE CDF data file into a |MATPOWER| case struct.
 % ::
 %
 %   MPC = CDF2MPC(CDF_FILE_NAME)

lib/compare_case.m

@@ -1,5 +1,5 @@
 function compare_case(mpc1, mpc2)
-% compare_case - Compares the bus, gen, branch matrices of 2 MATPOWER cases.
+% compare_case - Compares the bus, gen, branch matrices of 2 |MATPOWER| cases.
 % ::
 %
 %   COMPARE_CASE(MPC1, MPC2)

lib/connected_components.m

@@ -1,5 +1,5 @@
 function [groups, unvisited] = connected_components(C, groups, unvisited)
-% connected_components - Returns the connected components of a graph
+% connected_components - Returns the connected components of a graph.
 % ::
 %
 %   [GROUPS, ISOLATED] = CONNECTED_COMPONENTS(C)

lib/cpf_corrector.m

@@ -1,6 +1,6 @@
 function [V, converged, i, lam] = cpf_corrector(Ybus, Sbusb, V_hat, ref, pv, pq, ...
                 lam_hat, Sbust, Vprv, lamprv, z, step, parameterization, mpopt)
-% cpf_corrector - Solves the corrector step of a continuation power flow
+% cpf_corrector - Solves the corrector step of a continuation power flow.
 % ::
 %
 %   [V, CONVERGED, I, LAM] = CPF_CORRECTOR(YBUS, SBUSB, V_HAT, REF, PV, PQ, ...

lib/cpf_current_mpc.m

@@ -1,5 +1,5 @@
 function mpc = cpf_current_mpc(mpc, mpct, Ybus, Yf, Yt, ref, pv, pq, V, lam, mpopt)
-% cpf_current_mpc - Construct MPC for current continuation step.
+% cpf_current_mpc - Construct ``mpc`` for current continuation step.
 % ::
 %
 %   MPC = CPF_CURRENT_MPC(MPC_BASE, MPC_TARGET, YBUS, YF, YT, REF, PV, PQ, V, LAM, MPOPT)

lib/cpf_default_callback.m

@@ -1,7 +1,7 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = ...
     cpf_default_callback(k, nx, cx, px, done, rollback, evnts, ...
                             cb_data, cb_args, results)
-% cpf_default_callback - Default callback function for CPF
+% cpf_default_callback - Default callback function for CPF.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] = 

lib/cpf_detect_events.m

@@ -1,5 +1,5 @@
 function [rollback, evnts, cef] = cpf_detect_events(cpf_events, cef, pef, step, verbose)
-% cpf_detect_events - Detect events from event function values
+% cpf_detect_events - Detect events from event function values.
 % ::
 %
 %   [ROLLBACK, CRITICAL_EVENTS, CEF] = CPF_DETECT_EVENTS(CPF_EVENTS, CEF, PEF, STEP, VERBOSE)

lib/cpf_flim_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_flim_event(cb_data, cx)
-% cpf_flim_event - Event function to detect branch flow limit (MVA) violations
+% cpf_flim_event - Event function to detect branch flow limit (MVA) violations.
 % ::
 %
 %   EF = CPF_FLIM_EVENT(CB_DATA, CX)

lib/cpf_flim_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_flim_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_flim_event_cb - Callback to handle FLIM events
+% cpf_flim_event_cb - Callback to handle FLIM events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] =

lib/cpf_nose_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_nose_event(cb_data, cx)
-% cpf_nose_event - Event function to detect the nose point
+% cpf_nose_event - Event function to detect the nose point.
 % ::
 %
 %   EF = CPF_NOSE_EVENT(CB_DATA, CX)

lib/cpf_nose_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_nose_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_nose_event_cb - Callback to handle NOSE events
+% cpf_nose_event_cb - Callback to handle NOSE events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] = 

lib/cpf_plim_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_plim_event(cb_data, cx)
-% cpf_plim_event - Event function to detect gen active power limit violations
+% cpf_plim_event - Event function to detect gen active power limit violations.
 % ::
 %
 %   EF = CPF_PLIM_EVENT(CB_DATA, CX)

lib/cpf_plim_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_plim_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_plim_event_cb - Callback to handle PLIM events
+% cpf_plim_event_cb - Callback to handle PLIM events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] =

lib/cpf_predictor.m

@@ -1,5 +1,5 @@
 function [V_hat, lam_hat] = cpf_predictor(V, lam, z, step, pv, pq)
-% cpf_predictor - Performs the predictor step for the continuation power flow
+% cpf_predictor - Performs the predictor step for the continuation power flow.
 % ::
 %
 %   [V_HAT, LAM_HAT] = CPF_PREDICTOR(V, LAM, Z, STEP, PV, PQ)

lib/cpf_qlim_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_qlim_event(cb_data, cx)
-% cpf_qlim_event - Event function to detect gen reactive power limit violations
+% cpf_qlim_event - Event function to detect gen reactive power limit violations.
 % ::
 %
 %   EF = CPF_QLIM_EVENT(CB_DATA, CX)

lib/cpf_qlim_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_qlim_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_qlim_event_cb - Callback to handle QLIM events
+% cpf_qlim_event_cb - Callback to handle QLIM events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] =

lib/cpf_register_callback.m

@@ -1,5 +1,5 @@
 function cpf_callbacks = cpf_register_callback(cpf_callbacks, fcn, priority, args)
-% cpf_register_callback - Register CPF callback functions
+% cpf_register_callback - Register CPF callback functions.
 % ::
 %
 %   CPF_CALLBACKS = CPF_REGISTER_CALLBACK(CPF_CALLBACKS, FCN, PRIORITY)

lib/cpf_register_event.m

@@ -1,5 +1,5 @@
 function cpf_events = cpf_register_event(cpf_events, name, fcn, tol, locate)
-% cpf_register_event - Register event functions=
+% cpf_register_event - Register event functions.
 % ::
 %
 %   CPF_EVENTS = CPF_REGISTER_EVENT(CPF_EVENTS, NAME, FCN, TOL, LOCATE)

lib/cpf_tangent.m

@@ -1,6 +1,6 @@
 function z = cpf_tangent(V, lam, Ybus, Sbusb, Sbust, pv, pq, ...
                             zprv, Vprv, lamprv, parameterization, direction)
-% cpf_tangent - Computes normalized tangent predictor for continuation power flow
+% cpf_tangent - Computes normalized tangent predictor for continuation power flow.
 % ::
 %
 %   Z = CPF_TANGENT(V, LAM, YBUS, SBUSB, SBUST, PV, PQ, ...

lib/cpf_target_lam_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_target_lam_event(cb_data, cx)
-% cpf_target_lam_event - Event function to detect a target lambda value
+% cpf_target_lam_event - Event function to detect a target lambda value.
 % ::
 %
 %   EF = CPF_TARGET_LAM_EVENT(CB_DATA, CX)

lib/cpf_target_lam_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_target_lam_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_target_lam_event_cb - Callback to handle TARGET_LAM events
+% cpf_target_lam_event_cb - Callback to handle TARGET_LAM events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] = 

lib/cpf_vlim_event.m

@@ -1,5 +1,5 @@
 function ef = cpf_vlim_event(cb_data, cx)
-% cpf_vlim_event - Event function to detect bus voltage limit violations
+% cpf_vlim_event - Event function to detect bus voltage limit violations.
 % ::
 %
 %   EF = CPF_VLIM_EVENT(CB_DATA, CX)

lib/cpf_vlim_event_cb.m

@@ -1,6 +1,6 @@
 function [nx, cx, done, rollback, evnts, cb_data, results] = cpf_vlim_event_cb(...
         k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results)
-% cpf_vlim_event_cb - Callback to handle VLIM events
+% cpf_vlim_event_cb - Callback to handle VLIM events.
 % ::
 %
 %   [NX, CX, DONE, ROLLBACK, EVNTS, CB_DATA, RESULTS] =

lib/e2i_field.m

@@ -1,5 +1,5 @@
 function mpc = e2i_field(mpc, field, ordering, dim)
-% e2i_field - Converts fields of MPC from external to internal indexing.
+% e2i_field - Converts fields of ``mpc`` from external to internal indexing.
 % ::
 %
 %   This function performs several different tasks, depending on the

lib/have_feature_table.m

@@ -1,5 +1,5 @@
 function [TorF, vstr, rdate] = have_feature_table()
-% have_feature_table - Detect availability/version info for TABLE.
+% have_feature_table - Detect availability/version info for :class:`table`.
 %
 % Private feature detection function implementing ``'table'`` tag for
 % have_feature to detect availability/version of TABLE, included in

lib/i2e_field.m

@@ -1,5 +1,5 @@
 function mpc = i2e_field(mpc, field, ordering, dim)
-% i2e_field - Converts fields of MPC from internal to external bus numbering.
+% i2e_field - Converts fields of ``mpc`` from internal to external bus numbering.
 % ::
 %
 %   MPC = I2E_FIELD(MPC, FIELD, ORDERING)

lib/idx_brch.m

@@ -1,7 +1,7 @@
 function [F_BUS, T_BUS, BR_R, BR_X, BR_B, RATE_A, RATE_B, ...
     RATE_C, TAP, SHIFT, BR_STATUS, PF, QF, PT, QT, MU_SF, MU_ST, ...
     ANGMIN, ANGMAX, MU_ANGMIN, MU_ANGMAX] = idx_brch
-% idx_brch - Defines constants for named column indices to branch matrix.
+% idx_brch - Defines constants for named column indices to ``branch`` matrix.
 % ::
 %
 %   Example:

lib/idx_bus.m

@@ -1,6 +1,6 @@
 function [PQ, PV, REF, NONE, BUS_I, BUS_TYPE, PD, QD, GS, BS, BUS_AREA, VM, ...
     VA, BASE_KV, ZONE, VMAX, VMIN, LAM_P, LAM_Q, MU_VMAX, MU_VMIN] = idx_bus
-% idx_bus - Defines constants for named column indices to bus matrix.
+% idx_bus - Defines constants for named column indices to ``bus`` matrix.
 % ::
 %
 %   Example:

lib/idx_cost.m

@@ -1,5 +1,5 @@
 function [PW_LINEAR, POLYNOMIAL, MODEL, STARTUP, SHUTDOWN, NCOST, COST] = idx_cost
-% idx_cost - Defines constants for named column indices to gencost matrix.
+% idx_cost - Defines constants for named column indices to ``gencost`` matrix.
 % ::
 %
 %   Example:

lib/idx_dcline.m

@@ -1,5 +1,5 @@
 function c = idx_dcline
-% idx_dcline - Defines constants for named column indices to dcline matrix.
+% idx_dcline - Defines constants for named column indices to ``dcline`` matrix.
 % ::
 %
 %   Example:

lib/idx_gen.m

@@ -1,7 +1,7 @@
 function [GEN_BUS, PG, QG, QMAX, QMIN, VG, MBASE, GEN_STATUS, PMAX, PMIN, ...
     MU_PMAX, MU_PMIN, MU_QMAX, MU_QMIN, PC1, PC2, QC1MIN, QC1MAX, ...
     QC2MIN, QC2MAX, RAMP_AGC, RAMP_10, RAMP_30, RAMP_Q, APF] = idx_gen
-% idx_gen - Defines constants for named column indices to gen matrix.
+% idx_gen - Defines constants for named column indices to ``gen`` matrix.
 % ::
 %
 %   Example:

lib/loadcase.m

@@ -1,5 +1,5 @@
 function [baseMVA, bus, gen, branch, areas, gencost, info] = loadcase(casefile)
-% loadcase - Load .m or .mat case files or data struct in MATPOWER format.
+% loadcase - Load ``.m`` or ``.mat`` case files or data struct in |MATPOWER| format.
 % ::
 %
 %   [BASEMVA, BUS, GEN, BRANCH, AREAS, GENCOST] = LOADCASE(CASEFILE)

lib/pfsoln.m

@@ -1,5 +1,5 @@
 function [bus, gen, branch] = pfsoln(baseMVA, bus0, gen0, branch0, Ybus, Yf, Yt, V, ref, pv, pq, mpopt)
-% pfsoln - Updates bus, gen, branch data structures to match power flow soln.
+% pfsoln - Updates ``bus``, ``gen``, ``branch`` data structures to match power flow soln.
 % ::
 %
 %   [BUS, GEN, BRANCH] = PFSOLN(BASEMVA, BUS0, GEN0, BRANCH0, ...

lib/save2psse.m

@@ -1,5 +1,5 @@
 function fname_out = save2psse(fname, mpc, rawver)
-% save2psse - Saves a MATPOWER case to PSS/E RAW format.
+% save2psse - Saves a |MATPOWER| case to PSS/E RAW format.
 % ::
 %
 %   SAVE2PSSE(FNAME, MPC)

lib/savecase.m

@@ -1,5 +1,5 @@
 function fname_out = savecase(fname, varargin)
-% savecase - Saves a MATPOWER case file, given a filename and the data.
+% savecase - Saves a |MATPOWER| case file, given a filename and the data.
 % ::
 %
 %   SAVECASE(FNAME, CASESTRUCT)

lib/t/t_port_inj_current_acc.m

@@ -1,5 +1,5 @@
 function obj = t_port_inj_current_acc(quiet)
-%m t_port_inj_current_acc - Tests of port_inj_current() derivatives wrt cartesian V.
+% t_port_inj_current_acc - Tests of mp.form_ac.port_inj_current derivatives wrt cartesian V.
 
 %   MATPOWER
 %   Copyright (c) 2019-2024, Power Systems Engineering Research Center (PSERC)

lib/t/t_port_inj_current_acp.m

@@ -1,5 +1,5 @@
 function obj = t_port_inj_current_acp(quiet)
-% t_port_inj_current_acp - Tests of port_inj_current() derivatives wrt polar V.
+% t_port_inj_current_acp - Tests of mp.form_ac.port_inj_current derivatives wrt polar V.
 
 %   MATPOWER
 %   Copyright (c) 2019-2024, Power Systems Engineering Research Center (PSERC)

lib/t/t_port_inj_power_acc.m

@@ -1,5 +1,5 @@
 function obj = t_port_inj_power_acc(quiet)
-%nt_port_inj_power_acc - Tests of port_inj_power() derivatives wrt cartesian V.
+% t_port_inj_power_acc - Tests of mp.form_ac.port_inj_power derivatives wrt cartesian V.
 
 %   MATPOWER
 %   Copyright (c) 2019-2024, Power Systems Engineering Research Center (PSERC)

lib/t/t_port_inj_power_acp.m

@@ -1,5 +1,5 @@
 function obj = t_port_inj_power_acp(quiet)
-%nt_port_inj_power_acp - Tests of port_inj_power() derivatives wrt polar V.
+% t_port_inj_power_acp - Tests of mp.form_ac.port_inj_power derivatives wrt polar V.
 
 %   MATPOWER
 %   Copyright (c) 2019-2024, Power Systems Engineering Research Center (PSERC)