Docs : Make all headings sentence case

GafferHQ · May 15, 2019 · f2d60e5 · f2d60e5
1 parent f523682
commit f2d60e5
Show file tree

Hide file tree

Showing 26 changed files with 116 additions and 116 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -14,12 +14,12 @@ about: Create a report to help us improve
 Provide a description of the problem/bug
 
 
-### Steps to Reproduce ###
+### Steps to reproduce ###
 
 1. List the steps required for others to reproduce the issue
 
 
-### Debug Log ###
+### Debug log ###
 
 <details>
 <summary>Click to Expand</summary><p>

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,6 +1,6 @@
 # Code of Conduct #
 
-## Our Pledge ##
+## Our pledge ##
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
@@ -10,7 +10,7 @@ education, socio-economic status, nationality, personal appearance, race,
 religion, or sexual identity and orientation.
 
 
-## Our Standards ##
+## Our standards ##
 
 Examples of behavior that contributes to creating a positive environment
 include:
@@ -33,7 +33,7 @@ Examples of unacceptable behavior by participants include:
   professional setting
 
 
-## Our Responsibilities ##
+## Our responsibilities ##
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,7 +5,7 @@ The Gaffer team always welcomes quality contributions and issue reports. The fol
 Feel free to join the discussion on the [Gaffer community group](https://groups.google.com/forum/#!forum/gaffer-dev). It is the main public space for Gaffer-related questions, issues, and requests. If you are new to Gaffer development, we recommend browsing the latest discussions to develop a sense for the current priorities and familiarize yourself with the development flow.
 
 
-## Reporting Bugs ##
+## Reporting bugs ##
 
 If you discover behaviour in Gaffer that you suspect is a bug, first:
 
@@ -21,9 +21,9 @@ If your Issue requires a debug log, you must run Gaffer in a debugger (GDB) and
 3. When an error or a crash occurs, copy the output of the log.
 
 
-## Contributing Code ##
+## Contributing code ##
 
-### Pull Requests ###
+### Pull requests ###
 
 If you have a fork of Gaffer and have made improvements, and you would like to see them merged with the main project, you can create a new [Pull Request](https://github.com/GafferHQ/gaffer/pulls) (PR). Make sure to fill out the PR template on GitHub.
 
@@ -45,15 +45,15 @@ Each commit in your PR must perform one logically distinct set of changes. It mu
 We have several message best practices, which, if followed, result in a succinct, informative commit history that can be natively displayed in a variety of disparate protocols and applications, such as email and IDEs. The goal is for anyone to be able to look through the commit log on its own and have a reasonably detailed idea of what was changed and why.
 
 
-#### Commit Message Best Practices ####
+#### Commit message best practices ####
 
 - Each line of the message should be 72 characters or less.
 - The first line's message should start with the name of the module or area of the project being affected, followed by a space, a colon, another space, and finally by a _general_ description. Example: `Interface : Add MyButton`.
 - If the message is multi-line, the second line should be blank, to preserve formatting.
 - If the commit makes several small but important changes, list them line-by-line, with each line starting with a hyphen followed by a space, followed by a description of the change.
 
 
-### Example Commits for a New Feature ###
+### Example commits for a new Feature ###
 
 #### Commit 1 ####
 

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -2,15 +2,15 @@ Generally describe what this PR will do, and why it is needed
 
 - List specific new features and changes to project components
 
-### Related Issues ###
+### Related issues ###
 
 - List any Issues this PR addresses or solves
 
 ### Dependencies ###
 
 - List any other unmerged PRs that this PR depends on
 
-### Breaking Changes ###
+### Breaking changes ###
 
 - List any breaking API/ABI changes  (and apply the pr-majorVersion label)
 

diff --git a/README.md b/README.md
@@ -27,14 +27,14 @@ Compiled binary releases are available for download from the [releases page](htt
 Gaffer is a fairly large project, and as such has a fairly complex build process. Before you start, make sure you have the following prerequisites installed on your system, which will be used to perform the build itself.
 
 
-### Build Requirements ###
+### Build requirements ###
 
 From time to time, this list may change. For a complete, accurate, and up-to-date method of installing the prerequisites on CentOS, refer to the [Docker setup](https://github.com/GafferHQ/build/blob/master/Dockerfile) we use for building automatic releases.
 
 > **Note:** Specific package names may differ depending on your Linux distribution and repository.
 
 
-#### Main Build Requirements ####
+#### Main build requirements ####
 
 > **Note:** Large Linux distros focused on usability, such as CentOS and Ubuntu, ship with many of these packages by default.
 
@@ -51,7 +51,7 @@ Package Name | Minimum Version
 [mesa-libGLU-devel](https://www.mesa3d.org) |
 
 
-#### Documentation Build Requirements ####
+#### Documentation build requirements ####
 
 > **Note:** Building the documentation is optional.
 
@@ -68,7 +68,7 @@ sphinx_rtd_theme |
 recommonmark |
 
 
-### Build Process ###
+### Build process ###
 
 Gaffer also depends on a number of 3rd-party libraries and python modules, many of which are not entirely straightforward to build. We therefore recommend using the latest pre-built dependencies from the [Gaffer dependencies project](https://github.com/GafferHQ/dependencies/releases). These are used in our automated test builds and so are guaranteed to be up-to-date with Gaffer's requirements.
 
@@ -88,22 +88,22 @@ scons BUILD_DIR=<BUILD_DIR> build
 ```
 
 
-## Questions and Troubleshooting ##
+## Questions and troubleshooting ##
 
 If you have any questions about using Gaffer, or encounter problems setting it up, feel free to ask on the [Gaffer community group](https://groups.google.com/forum/#!forum/gaffer-dev). Our users and contributors are happy to help.
 
 
-## Requesting Features ##
+## Requesting features ##
 
 If there is a feature you would like to see in Gaffer, request it on the [Gaffer community group](https://groups.google.com/forum/#!forum/gaffer-dev). Do not create an Issue for it on GitHub.
 
 
-## Contributions and Bugs Reports ##
+## Contributions and bugs reports ##
 
 Please see the project's [contribution guidelines](CONTRIBUTING.md).
 
 
-## Copyright and License ##
+## Copyright and license ##
 
 © 2011–2019 John Haddon. All rights reserved.
 

diff --git a/doc/source/GettingStarted/ConfiguringGafferForThirdPartyTools/index.md b/doc/source/GettingStarted/ConfiguringGafferForThirdPartyTools/index.md
@@ -185,7 +185,7 @@ Once the tractor folder has been added to your `PYTHONPATH`, you can then verify
 <!-- TODO: ![Tractor dispatch](images/tractorDispatch.png) -->
 
 
-## See Also ##
+## See also ##
 
 - [Setting Up the "gaffer" Command](../SettingUpGafferCommand/index.md)
 - [Installing Gaffer](../InstallingGaffer/index.md)
diff --git a/doc/source/GettingStarted/InstallingGaffer/index.md b/doc/source/GettingStarted/InstallingGaffer/index.md
@@ -42,7 +42,7 @@ To install Gaffer in OSX:
 Gaffer is now installed to `/opt/gaffer-!GAFFER_VERSION!-osx`.
 
 
-## See Also ##
+## See also ##
 
 - [Launching Gaffer for the First Time](../LaunchingGafferFirstTime/index.md)
 - [Setting Up the "gaffer" Command](../SettingUpGafferCommand/index.md)

diff --git a/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md b/doc/source/GettingStarted/LaunchingGafferFirstTime/index.md
@@ -39,7 +39,7 @@ To launch Gaffer for the first time in OSX:
 Gaffer will launch in a new window.
 
 
-## See Also ##
+## See also ##
 
 - [Installing Gaffer](../InstallingGaffer/index.md)
 - [Setting Up the "gaffer" Command](../SettingUpGafferCommand/index.md)

diff --git a/doc/source/GettingStarted/SettingUpGafferCommand/index.md b/doc/source/GettingStarted/SettingUpGafferCommand/index.md
@@ -6,14 +6,14 @@ After you have installed Gaffer, it will remain a collection of files and direct
 > For these instructions, we will assume you have Gaffer installed to the `/opt/` directory. If you have installed it elsewhere, replace `/opt/` with the directory you installed it to.
 
 
-### Environment Variables ###
+### Environment variables ###
 
 An environment variable is simply a value, such as a string, number, boolean, or location that your terminal is aware of. For instance, when you ran the `tar` command to extract the downloaded Gaffer package, the `tar` command was not located in your `~/Downloads` directory, but actually in `/usr/bin/`. Whenever you open your terminal, several folders are added to your terminal's `PATH` environment variable, which provides it with a list of locations in the file system from which it can source commands.
 
 In order for the `gaffer` command to work in your terminal, you will need to add Gaffer's directory to the `PATH` environment variable.
 
 
-## Setting Up the "gaffer" Command in Linux ##
+## Setting up the "gaffer" command in Linux ##
 
 The particular terminal on your system depends on your Linux distribution and how it was configured. Most distributions of Linux use _bash_, but there are other common terminals available, like _tcsh_. Because we cannot accommodate every available terminal, we will only provide instructions for adding to the `PATH` variable in _bash_ and _tcsh_.
 
@@ -49,7 +49,7 @@ To set up the `gaffer` command in Linux:
 You can now execute `gaffer` as a command from any directory in the terminal.
 
 
-## Setting Up the "gaffer" Command in OSX ##
+## Setting up the "gaffer" command in OSX ##
 
 The default terminal in OSX is _bash_, so you will need to add to the `PATH` variable in the _bash_ user config.
 
@@ -74,7 +74,7 @@ To set up the `gaffer` command in OSX:
 You can now execute `gaffer` as a command from any directory in the terminal.
 
 
-## Using the "gaffer" Command ##
+## Using the "gaffer" command ##
 
 Once you have added the Gaffer directory to the `PATH` variable, you can launch Gaffer anywhere in the terminal:
 
@@ -85,7 +85,7 @@ gaffer
 You can also use the command to open Gaffer scripts, as outlined in the [Command Line Reference](../../Reference/CommandLineReference/index.md).
 
 
-## See Also ##
+## See also ##
 
 - [Installing Gaffer](../InstallingGaffer/index.md)
 - [Configuring Gaffer for Third-Party Tools](../ConfiguringGafferForThirdPartyTools/index.md)
diff --git a/doc/source/GettingStarted/index.md b/doc/source/GettingStarted/index.md
@@ -3,13 +3,13 @@
 Here you can find information and instructions about how to install and configure Gaffer.
 
 
-### Quick Installation ###
+### Quick installation ###
 
 - [Installing Gaffer](InstallingGaffer/index.md)
 - [Launching Gaffer for the First Time](LaunchingGafferFirstTime/index.md)
 
 
-### Complete Installation ###
+### Complete installation ###
 
 - [Setting Up the "gaffer" Command](SettingUpGafferCommand/index.md)
 - [Configuring Gaffer for Third-Party Tools](ConfiguringGafferForThirdPartyTools/index.md)

diff --git a/doc/source/Interface/ControlsAndShortcuts/index.md b/doc/source/Interface/ControlsAndShortcuts/index.md
@@ -15,7 +15,7 @@ The following is a list of input device controls and shortcuts for manipulating
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 New node graph                        :kbd:`Ctrl` + :kbd:`N`
 Open node graph                       :kbd:`Ctrl` + :kbd:`O`
@@ -40,7 +40,7 @@ Hide tabs of current panel            :kbd:`Ctrl` + :kbd:`T`
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Pan                                   :kbd:`Alt` + click and drag
 Zoom                                  :kbd:`Alt` + right-click and drag
@@ -61,7 +61,7 @@ Frame to numeric bookmark             :kbd:`1` … :kbd:`9`
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Show node menu                        Right-click
                                       
@@ -81,7 +81,7 @@ Insert `Dot` at connection            :kbd:`Ctrl` + click connection
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Select all                            :kbd:`Ctrl` + :kbd:`A`
 Clear selection                       :kbd:`Ctrl` + :kbd:`Shift` + :kbd:`A`
@@ -102,7 +102,7 @@ Select downstream nodes               :kbd:`Shift` + :kbd:`Ctrl` + click node
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Dispatch selected node(s)             :kbd:`Ctrl` + :kbd:`E`
 Redo last dispatch                    :kbd:`Ctrl` + :kbd:`R`
@@ -117,7 +117,7 @@ Redo last dispatch                    :kbd:`Ctrl` + :kbd:`R`
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Cut node(s)                           :kbd:`Ctrl` + :kbd:`X`
 Copy node(s)                          :kbd:`Ctrl` + :kbd:`C`
@@ -136,7 +136,7 @@ Enable/disable node(s)                :kbd:`D`
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Connect plug                          Click and drag plug to another plug
 Disconnect plug                       Click and drag connection to background
@@ -152,7 +152,7 @@ Duplicate outgoing connection         :kbd:`Shift`-click and drag connection jus
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Bookmark node                         Right-click node > *Bookmark*
 Connect to bookmarked node            Right-click plug > *Connect Bookmark* > select
@@ -178,7 +178,7 @@ Remove numeric bookmark               :kbd:`Ctrl` + :kbd:`0`
 
 ```eval_rst
 ============================================== ===============================================
-Action                                         Control or Shorcut
+Action                                         Control or shorcut
 ============================================== ===============================================
 Increment/decrement value, specific precision  Position cursor next to a number position in 
                                                plug field, then hit :kbd:`↑` / :kbd:`↓`
@@ -195,7 +195,7 @@ Gang plugs together                            :kbd:`Ctrl` + :kbd:`G`
 
 ```eval_rst
 ==================================== ================================================
-Action                               Control or Shorcut
+Action                               Control or shorcut
 ==================================== ================================================
 Autocomplete path component          :kbd:`Tab`
 Path-level contents menu             Select path component
@@ -219,7 +219,7 @@ Path hierarchy menu                  Select all
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Pan                                   :kbd:`Alt` + click and drag
 Zoom/dolly                            :kbd:`Alt` + right-click and drag
@@ -243,7 +243,7 @@ Pin to numeric bookmark               :kbd:`1` … :kbd:`9`
 
 ```eval_rst
 ====================================================== =====================================
-Action                                                 Control or Shortcut
+Action                                                 Control or shortcut
 ====================================================== =====================================
 Tumble                                                 :kbd:`Alt` + click and drag
 Expand selection                                       :kbd:`↓`
@@ -272,7 +272,7 @@ Reset clipping planes                                  Right-click > *Clipping
 
 ```eval_rst
 ==================================================== =============================================
-Action                                               Control or Shortcut
+Action                                               Control or shortcut
 ==================================================== =============================================
 Increase manipulator size                            :kbd:`+`
 Decrease manipulator size                            :kbd:`-`
@@ -285,7 +285,7 @@ Add animation key to transform of selected object(s) :kbd:`S`
 
 ```eval_rst
 ===================================== =============================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== =============================================
 Isolate red channel                   :kbd:`R`
 Isolate green channel                 :kbd:`G`
@@ -306,7 +306,7 @@ Center image at 1:1 scale             :kbd:`Home`
 
 ```eval_rst
 ================================================== ================================================
-Action                                             Control or Shortcut
+Action                                             Control or shortcut
 ================================================== ================================================
 Drop node into *Python Editor*                     Middle-click and drag node from *Node Graph*
 Drop plug into *Python Editor*                     Middle-click and drag plug from *Node Graph* 
@@ -330,7 +330,7 @@ Drop scene location path(s) into *Python Editor*   Click and drag selection from
 
 ```eval_rst
 ===================================== ===================================================
-Action                                Control or Shortcut
+Action                                Control or shortcut
 ===================================== ===================================================
 Execute and clear                     :kbd:`Ctrl` + :kbd:`Enter`
 Execute selection                     Select code, then hit :kbd:`Ctrl` + :kbd:`Enter`
@@ -345,7 +345,7 @@ Execute selection                     Select code, then hit :kbd:`Ctrl` + :kbd:`
 
 ```eval_rst
 =============================================== =============================================
-Action                                          Control or Shortcut
+Action                                          Control or shortcut
 =============================================== =============================================
 Pan                                             :kbd:`Alt` + click and drag
 Zoom                                            :kbd:`Alt` + right-click and drag