Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_SOI_filtering.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Applying a filter to a time-series
Applying a Filter to a Time-Series
==================================

This example demonstrates low pass filtering a time-series by applying a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Colouring anomaly data with logarithmic scaling
Colouring Anomaly Data With Logarithmic Scaling
===============================================

In this example, we need to plot anomaly data where the values have a
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_coriolis.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Deriving the Coriolis frequency over the globe
Deriving the Coriolis Frequency Over the Globe
==============================================

This code computes the Coriolis frequency and stores it in a cube with
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_cross_section.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Cross section plots
Cross Section Plots
===================

This example demonstrates contour plots of a cross-sectioned multi-dimensional
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_custom_aggregation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Calculating a custom statistic
Calculating a Custom Statistic
==============================

This example shows how to define and use a custom
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_custom_file_loading.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Loading a cube from a custom file format
Loading a Cube From a Custom File Format
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe “from” should be lower case.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This example shows how a custom text file can be loaded using the standard Iris
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_global_map.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Quickplot of a 2d cube on a map
Quickplot of a 2D Cube on a Map
===============================

This example demonstrates a contour plot of global air temperature. The plot
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Multi-line temperature profile plot
Multi-Line Temperature Profile Plot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

"""
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_polar_stereo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Example of a polar stereographic plot
Example of a Polar Stereographic Plot
=====================================

Demonstrates plotting data that are defined on a polar stereographic
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_polynomial_fit.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Fitting a polynomial
Fitting a Polynomial
====================

This example demonstrates computing a polynomial fit to 1D data from an Iris
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Plotting in different projections
Plotting in Different Projections
=================================

This example shows how to overlay data and graphics in different projections,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Rotated pole mapping
Rotated Pole Mapping
=====================

This example uses several visualisation methods to achieve an array of
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_COP_1d.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Global average annual temperature plot
Global Average Annual Temperature Plot
======================================

Produces a time-series plot of North American temperature forecasts for 2
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_COP_maps.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Global average annual temperature maps
Global Average Annual Temperature Maps
======================================

Produces maps of global temperature forecasts from the A1B and E1 scenarios.
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_TEC.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Ionosphere space weather
Ionosphere Space Weather
========================

This space weather example plots a filled contour of rotated pole point
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_hovmoller.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Hovmoller diagram of monthly surface temperature
Hovmoller Diagram of Monthly Surface Temperature
================================================

This example demonstrates the creation of a Hovmoller diagram with fine control
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Seasonal ensemble model plots
Seasonal Ensemble Model Plots
=============================

This example demonstrates the loading of a lagged ensemble dataset from the
Expand Down
4 changes: 2 additions & 2 deletions docs/iris/gallery_code/meteorology/plot_wind_speed.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Plotting wind direction using quiver
===========================================================
Plotting Wind Direction Using Quiver
====================================

This example demonstrates using quiver to plot wind speed contours and wind
direction arrows from wind vector component input data. The vector components
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Oceanographic profiles and T-S diagrams
Oceanographic Profiles and T-S Diagrams
=======================================

This example demonstrates how to plot vertical profiles of different
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/oceanography/plot_load_nemo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Load a time series of data from the NEMO model
Load a Time Series of Data From the NEMO Model
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“from”?

==============================================
This example demonstrates how to load multiple files containing data output by
Expand Down
6 changes: 3 additions & 3 deletions docs/iris/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ def autolog(message):
"menu_links_name": "Support",
"menu_links": [
(
'<i class="fa fa-github fa-fw"></i> Source code',
'<i class="fa fa-github fa-fw"></i> Source Code',
"https://github.com/SciTools/iris",
),
(
Expand All @@ -242,11 +242,11 @@ def autolog(message):
"https://groups.google.com/forum/#!forum/scitools-iris-dev",
),
(
'<i class="fa fa-question fa-fw"></i> StackOverflow for "How do I?"',
'<i class="fa fa-question fa-fw"></i> StackOverflow for "How Do I?"',
"https://stackoverflow.com/questions/tagged/python-iris",
),
(
'<i class="fa fa-book fa-fw"></i> Legacy documentation',
'<i class="fa fa-book fa-fw"></i> Legacy Documentation',
"https://scitools.org.uk/iris/docs/v2.4.0/index.html",
),
],
Expand Down
6 changes: 3 additions & 3 deletions docs/iris/src/copyright.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

Iris copyright, licensing and contributors
Iris Copyright, Licensing and Contributors
==========================================

Iris code
Iris Code
---------

All Iris source code, unless explicitly stated, is ``Copyright Iris
Expand All @@ -20,7 +20,7 @@ You should find all source files with the following header:
licensing details.


Iris documentation and examples
Iris Documentation and Examples
-------------------------------

All documentation, examples and sample data found on this website and in source repository
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/src/developers_guide/contributing_changes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. _contributing.changes:

Contributing your changes
Contributing Your Changes
=========================

.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _code_formatting:

Code formatting
Code Formatting
===============

To ensure a consistent code format throughout Iris, we recommend using
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _contributing.documentation.codebase:

Contributing to the code base
Contributing to the Code Base
=============================

.. toctree::
Expand Down
12 changes: 6 additions & 6 deletions docs/iris/src/developers_guide/contributing_deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ one release, before removing/updating it in the next
`major release <http://semver.org/>`_.


Adding a deprecation
Adding a Deprecation
====================

.. _removing-a-public-api:

Removing a public API
Removing a Public API
---------------------

The simplest form of deprecation occurs when you need to remove a public
Expand Down Expand Up @@ -49,7 +49,7 @@ Under these circumstances the following points apply:
- You should check the documentation for references to the deprecated
API and update them as appropriate.

Changing a default
Changing a Default
------------------

When you need to change the default behaviour of a public API the
Expand All @@ -74,7 +74,7 @@ API:
deprecation warning and corresponding Sphinx deprecation directive.


Removing a deprecation
Removing a Deprecation
======================

When the time comes to make a new major release you should locate any
Expand All @@ -83,15 +83,15 @@ minimum period described previously. Locating deprecated APIs can easily
be done by searching for the Sphinx deprecation directives and/or
deprecation warnings.

Removing a public API
Removing a Public API
---------------------

The deprecated API should be removed and any corresponding documentation
and/or example code should be removed/updated as appropriate.

.. _iris_developer_future:

Changing a default
Changing a Default
------------------

- You should update the initial state of the relevant boolean attribute
Expand Down
4 changes: 2 additions & 2 deletions docs/iris/src/developers_guide/contributing_documentation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. _contributing.documentation:

Contributing to the documentation
Contributing to the Documentation
---------------------------------

Documentation is important and we encourage any improvements that can be made.
Expand Down Expand Up @@ -112,7 +112,7 @@ or ignore the url.

.. _contributing.documentation.api:

Generating API documentation
Generating API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to auto generate the API documentation based upon the docstrings a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _development_where_to_start:

Getting involved
Getting Involved
----------------

Iris_ is an Open Source project hosted on Github and as such anyone with a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _testing.graphics:

Graphics tests
Graphics Tests
**************

Iris may be used to create various forms of graphical output; to ensure
Expand Down Expand Up @@ -31,7 +31,7 @@ known acceptable output may fail. The failure may also not be visually
perceived as it may be a simple pixel shift.


Testing strategy
Testing Strategy
================

The `Iris Travis matrix`_ defines multiple test runs that use
Expand Down Expand Up @@ -64,7 +64,7 @@ This consists of:
against the existing accepted reference images, for each failing test.


Reviewing failing tests
Reviewing Failing Tests
=======================

When you find that a graphics test in the Iris testing suite has failed,
Expand Down Expand Up @@ -122,7 +122,7 @@ you should follow:
happens, simply repeat the check-and-accept process until all tests pass.


Add your changes to Iris
Add Your Changes to Iris
========================

To add your changes to Iris, you need to make two pull requests (PR).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. _pr_check:

Pull request check list
=======================
Pull Request Checklist
======================

All pull request will be reviewed by a core developer who will manage the
process of merging. It is the responsibility of a developer submitting a
Expand Down
4 changes: 2 additions & 2 deletions docs/iris/src/developers_guide/contributing_running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _developer_running_tests:

Running the tests
Running the Tests
*****************

A prerequisite of running the tests is to have the Python environment
Expand Down Expand Up @@ -90,4 +90,4 @@ due to an experimental dependency not being present.

All Python decorators that skip tests will be defined in
``lib/iris/tests/__init__.py`` with a function name with a prefix of
``skip_``.
``skip_``.
8 changes: 4 additions & 4 deletions docs/iris/src/developers_guide/contributing_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.. _developer_test_categories:


Test categories
Test Categories
***************

There are two main categories of tests within Iris:
Expand All @@ -20,7 +20,7 @@ feel free to submit a pull-request in any state and ask for assistance.

.. _testing.unit_test:

Unit tests
Unit Tests
==========

Code changes should be accompanied by enough unit tests to give a
Expand Down Expand Up @@ -128,7 +128,7 @@ Within that file the tests might look something like:

.. _testing.integration:

Integration tests
Integration Tests
=================

Some code changes may require tests which exercise several units in
Expand All @@ -141,4 +141,4 @@ tests. But folders and files must be created as required to help
developers locate relevant tests. It is recommended they are named
according to the capabilities under test, e.g.
``metadata/test_pp_preservation.py``, and not named according to the
module(s) under test.
module(s) under test.
Loading