Rename nhsuk-typography-responsive mixin to nhsuk-font-size

Co-authored-by: owenatgov <owen.jones@digital.cabinet-office.gov.uk>

Author: colinrotherham

packages/core/tools/_typography.scss

@@ -81,14 +81,15 @@
   @return $line-height;
 }
 
-/// Responsive typography
+/// Font size and line height helper
 ///
-/// Takes a 'font map' as an argument and uses it to create font-size and
-/// line-height declarations for different breakpoints, and for print.
+/// Takes a point from the responsive 'font map' as an argument (the size as it
+/// would appear on tablet and above), and uses it to create font-size and
+/// line-height declarations for different breakpoints, and print.
 ///
 /// Example font map:
 ///
-/// $my-font-map: (
+/// 19: (
 ///   null: (
 ///     font-size: 16px,
 ///     line-height: 20px
@@ -101,29 +102,29 @@
 ///     font-size: 14pt,
 ///     line-height: 1.15
 ///   )
-/// );\
+/// );
 ///
 /// @example scss
 ///   .foo {
-///     @include nhsuk-typography-responsive(19);
+///     @include nhsuk-font-size(19);
 ///   }
 ///
 ///   .foo {
-///     @include nhsuk-typography-responsive(36, $important: true);
+///     @include nhsuk-font-size(36, $important: true);
 ///   }
 ///
-/// @param {Map} $font-map - Font map
+/// @param {Number} $size - Point from the spacing scale (the size as it would
+///   appear on tablet and above)
 /// @param {Number} $override-line-height [false] - Non responsive custom line
 ///   height. Omit to use the line height from the font map.
 /// @param {Boolean} $important [false] - Whether to mark declarations as
 ///   `!important`.
 ///
-/// 1. Mark rules as !important if $important is true - this will result in
-///    these variables becoming strings, so this needs to happen *after* they
-///    are used in calculations
+/// @throw if `$size` is not a valid point from the spacing scale
 ///
+/// @link https://github.com/alphagov/govuk-frontend Original code taken from GDS (Government Digital Service)
 
-@mixin nhsuk-typography-responsive($size, $override-line-height: false, $important: false) {
+@mixin nhsuk-font-size($size, $override-line-height: false, $important: false) {
   @if not map.has-key($nhsuk-typography-scale, $size) {
     @error "Unknown font size `#{$size}` - expected a point from the typography scale.";
   }
@@ -139,7 +140,9 @@
       $font-size: $font-size
     );
 
-    // [1]
+    // Mark rules as !important if $important is true - this will result in
+    // these variables becoming strings, so this needs to happen *after* they
+    // are used in calculations
     $font-size: $font-size if($important, !important, null);
     $font-size-rem: $font-size-rem if($important, !important, null);
     $line-height: $line-height if($important, !important, null);
@@ -165,6 +168,24 @@
   }
 }
 
+/// Font size and line height helper (deprecated)
+///
+/// @param {Number} $size - Point from the spacing scale (the size as it would
+///   appear on tablet and above)
+/// @param {Number} $override-line-height [false] - Non responsive custom line
+///   height. Omit to use the line height from the font map.
+/// @param {Boolean} $important [false] - Whether to mark declarations as
+///   `!important`.
+///
+/// @throw if `$size` is not a valid point from the spacing scale
+///
+/// @alias nhsuk-font-size
+/// @deprecated Use `nhsuk-font-size` instead
+
+@mixin nhsuk-typography-responsive($size, $override-line-height: false, $important: false) {
+  @include nhsuk-font-size($size, $override-line-height, $important);
+}
+
 /// Font
 ///
 /// @example scss
@@ -191,6 +212,6 @@
   }
 
   @if $size {
-    @include nhsuk-typography-responsive($size, $override-line-height: $line-height);
+    @include nhsuk-font-size($size, $override-line-height: $line-height);
   }
 }