Skip to content

Commit 3b726fd

Browse files
murrayrmmurrayrm
committed
fix capitalization of chapter and section titles
1 parent 5ff59ba commit 3b726fd

19 files changed

Lines changed: 69 additions & 65 deletions

‎doc/classes.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
.. _class-ref:
44

55
**********************
6-
Control system classes
6+
Control System Classes
77
**********************
88

9-
Input/output system classes
9+
Input/output System Classes
1010
===========================
1111

1212
The classes listed below are used to represent models of input/output
@@ -37,7 +37,7 @@ another:
3737
:align: center
3838

3939

40-
Response and plotting classes
40+
Response and Plotting Classes
4141
=============================
4242

4343
These classes are used as the outputs of `_response`, `_map`, and
@@ -57,7 +57,7 @@ More informaton on the functions used to create these classes can be
5757
found in the :ref:iosys-module chapter.
5858

5959

60-
Nonlinear system classes
60+
Nonlinear System Classes
6161
========================
6262

6363
These classes are used for various nonlinear input/output system

‎doc/config.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. _package-configuration-parameters:
44

5-
Package configuration parameters
5+
Package Configuration Parameters
66
================================
77

88
The python-control package can be customized to allow for different default

‎doc/descfcn.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. _descfcn-module:
44

5-
Describing functions
5+
Describing Functions
66
====================
77

88
For nonlinear systems consisting of a feedback connection between a

‎doc/develop.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ listing of the practices that have evolved over the course of
1010
development since the package was created in 2009.
1111

1212

13-
Package structure
13+
Package Structure
1414
=================
1515

1616
The python-control package is maintained on GitHub, with documentation
@@ -96,7 +96,7 @@ GitHub repository file and directory layout:
9696
+ \*.ipynb - Jupyter notebooks
9797

9898

99-
Naming conventions
99+
Naming Conventions
100100
==================
101101

102102
Generally speaking, standard Python and NumPy naming conventions are
@@ -206,7 +206,7 @@ Signal arguments:
206206
signals.
207207

208208

209-
Documentation guidelines
209+
Documentation Guidelines
210210
========================
211211

212212
The python-control package is documented using docstrings and Sphinx.
@@ -407,7 +407,7 @@ The reference manual should provide a fairly comprehensive description
407407
of every class, function and configuration variable in the package.
408408

409409

410-
Utility functions
410+
Utility Functions
411411
=================
412412

413413
The following utility functions can be used to help with standard
@@ -425,7 +425,7 @@ processing and parsing operations:
425425
xferfcn._convert_to_transfer_function
426426

427427

428-
Sample files
428+
Sample Files
429429
============
430430

431431

‎doc/examples.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ also be accessed online via the `python-control GitHub repository
1212
<https://github.com/python-control/python-control/tree/master/examples>`_.
1313

1414

15-
Python scripts
15+
Python Scripts
1616
==============
1717

1818
The following Python scripts document the use of a variety of methods in the
@@ -40,7 +40,7 @@ other sources.
4040
examples/markov
4141
examples/era_msd
4242

43-
Jupyter notebooks
43+
Jupyter Notebooks
4444
=================
4545

4646
The examples below use `python-control` in a Jupyter notebook environment.

‎doc/examples/template.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ def sample_function(data, option=False, **kwargs):
125125
-----
126126
This section can contain a more detailed description of how the system
127127
works. OK to include some limited mathematics, either via inline math
128-
directions for a short formula (like this: ..math: a = b c) or via a
128+
directions for a short formula (like this: ..math:`x = \alpha y`) or via a
129129
displayed equation:
130130
131131
..math::
@@ -137,8 +137,9 @@ def sample_function(data, option=False, **kwargs):
137137
138138
If you refer to parameters, such as the `data` argument to this
139139
function, but them in single backticks (which will render them in code
140-
style in Sphinx). You should also do this for Python contains like
141-
`True, `False`, and `None`.
140+
style in Sphinx). Strings that should be interpreted as Python code
141+
use double backticks: ``mag, phase, omega = response``. Python
142+
built-in objects, like True, False, and None are written on their own.
142143
143144
"""
144145
inputs = kwargs['inputs']

‎doc/flatsys.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _flatsys-module:
22

3-
Differentially flat systems
3+
Differentially Flat Systems
44
===========================
55

66
.. automodule:: control.flatsys

‎doc/functions.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _function-ref:
22

33
******************
4-
Function reference
4+
Function Reference
55
******************
66

77
.. Include header information from the main control module
@@ -11,7 +11,7 @@ Function reference
1111
:no-special-members:
1212

1313

14-
System creation
14+
System Creation
1515
===============
1616

1717
Functions that create input/output systems from a description of the
@@ -63,7 +63,7 @@ System interconnections
6363
connection_table
6464

6565

66-
Time response
66+
Time Response
6767
=============
6868

6969
.. autosummary::
@@ -102,7 +102,7 @@ Phase plane plots
102102
phaseplot.vectorfield
103103

104104

105-
Frequency response
105+
Frequency Response
106106
==================
107107

108108
.. autosummary::
@@ -120,7 +120,7 @@ Frequency response
120120
nichols_grid
121121

122122

123-
Control system analysis
123+
Control System Analysis
124124
=======================
125125

126126
Time domain analysis:
@@ -171,7 +171,7 @@ Passive systems analysis:
171171
solve_passivity_LMI
172172

173173

174-
Control system synthesis
174+
Control System Synthesis
175175
========================
176176

177177
State space synthesis:
@@ -197,7 +197,7 @@ Frequency domain synthesis:
197197
rootlocus_pid_designer
198198

199199

200-
System ID and model reduction
200+
System ID and Model Reduction
201201
=============================
202202
.. autosummary::
203203
:toctree: generated/
@@ -210,7 +210,7 @@ System ID and model reduction
210210
markov
211211

212212

213-
Nonlinear system support
213+
Nonlinear System Support
214214
========================
215215
.. autosummary::
216216
:toctree: generated/
@@ -275,7 +275,7 @@ Optimal control
275275
optimal.state_range_constraint
276276

277277

278-
Stochastic system support
278+
Stochastic System Support
279279
=========================
280280
.. autosummary::
281281
:toctree: generated/
@@ -287,7 +287,7 @@ Stochastic system support
287287
white_noise
288288

289289

290-
Matrix computations
290+
Matrix Computations
291291
===================
292292
.. autosummary::
293293
:toctree: generated/
@@ -302,7 +302,7 @@ Matrix computations
302302

303303
.. _utility-and-conversions:
304304

305-
Utility functions
305+
Utility Functions
306306
=================
307307
.. autosummary::
308308
:toctree: generated/

‎doc/index.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ or the GitHub site: https://github.com/python-control/python-control.
5151

5252
intro
5353
Tutorial <examples/python-control_tutorial.ipynb>
54-
Linear systems <linear>
55-
I/O response and plotting <response>
56-
Nonlinear systems <nonlinear>
57-
Interconnected I/O systems <iosys>
58-
Stochastic systems <stochastic>
54+
Linear Systems <linear>
55+
I/O Response and Plotting <response>
56+
Nonlinear Systems <nonlinear>
57+
Interconnected I/O Systems <iosys>
58+
Stochastic Systems <stochastic>
5959
examples
6060
genindex
6161

‎doc/intro.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ package, including documentation for all functions in the package and
88
examples illustrating their use.
99

1010

11-
Package overview
11+
Package Overview
1212
================
1313

1414
.. automodule:: control
@@ -85,7 +85,7 @@ Note that Google Colab does not currently support Slycot, so some
8585
functionality may not be available.
8686

8787

88-
Package conventions
88+
Package Conventions
8989
===================
9090

9191
The python-control package makes use of a few naming and calling conventions:
@@ -113,7 +113,7 @@ The python-control package makes use of a few naming and calling conventions:
113113
objects that include the input and output dimensions.
114114

115115

116-
Some differences from MATLAB
116+
Some Differences from MATLAB
117117
============================
118118

119119
Users familiar with the MATLAB control systems toolbox will find much

0 commit comments

Comments
 (0)