From b1e41d9f12a59390aacdb933889c3c4a87c9e8d2 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 30 Jun 2020 19:24:46 -0400 Subject: [PATCH] doc: correct 'Pstar' units (#325) * doc: correct 'Pstar' units `Pstar` is really in N/m^2, but is incorrectly listed as being in N/m. Fix that. * .github: add '.md' extension to PULL_REQUEST_TEMPLATE The GitHub documentation implicitely suggests using a '.md' extension for pull request template [1]. Let's follow that recommendation. [1] https://help.github.com/en/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository --- .github/{PULL_REQUEST_TEMPLATE => PULL_REQUEST_TEMPLATE.md} | 0 doc/source/icepack_index.rst | 2 +- doc/source/science_guide/sg_mechanical.rst | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE => PULL_REQUEST_TEMPLATE.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/doc/source/icepack_index.rst b/doc/source/icepack_index.rst index f3a7b447..da4dff18 100755 --- a/doc/source/icepack_index.rst +++ b/doc/source/icepack_index.rst @@ -352,7 +352,7 @@ either Celsius or Kelvin units). "PP_net", "total primary productivity per grid cell", "mg C/m\ :math:`^2`/s" "precip_units", ":math:`\bullet` liquid precipitation data units", "" "print_points", ":math:`\bullet` if true, print point data", "F" - "Pstar", "ice strength parameter", "2.75\ :math:`\times`\ 10\ :math:`^4`\ N/m" + "Pstar", "ice strength parameter", "2.75\ :math:`\times`\ 10\ :math:`^4`\ N/m\ :math:`^2`" "puny", "a small positive number", "1\ :math:`\times`\ 10\ :math:`^{-11}`" "**Q**", "", "" "Qa", "specific humidity at 10 m", "kg/kg" diff --git a/doc/source/science_guide/sg_mechanical.rst b/doc/source/science_guide/sg_mechanical.rst index 2c178b5f..8bae15b0 100755 --- a/doc/source/science_guide/sg_mechanical.rst +++ b/doc/source/science_guide/sg_mechanical.rst @@ -252,7 +252,7 @@ namelist parameter ``kstrength`` = 0, we use the strength formula from P = P^* h \exp[-C(1-a_i)], :label: hib-strength -where :math:`P^* = 27,500 \, \mathrm {N/m}` and :math:`C = 20` are +where :math:`P^* = 27,500 \, \mathrm {N/m^2}` and :math:`C = 20` are empirical constants, and :math:`h` is the mean ice thickness. Alternatively, setting ``kstrength`` = 1 gives an ice strength closely related to the ridging scheme. Following