From 12ee1407a1b385bbc65550e37930d941c124ebf3 Mon Sep 17 00:00:00 2001
From: JohnnyMorganz <johnnymorganz@outlook.com>
Date: Fri, 21 Oct 2022 16:05:56 +0100
Subject: [PATCH] Add named parameters to `math` lib (#722)

Name the parameters used in `math` lib

This is mainly done to highlight the particular confusion for
`math.atan2`, where `y` comes before `x`, but this might not be
immediately obvious.

And then I added the rest of the names for consistency.

Note: I didn't add names to `math.random` as it's currently typed as
`(number?, number?) -> number`. Naming it `min` and `max` is technically
incorrect for the 1 argument version.
Maybe it should be typed as an intersection instead?
---
 Analysis/src/EmbeddedBuiltinDefinitions.cpp | 58 ++++++++++-----------
 1 file changed, 29 insertions(+), 29 deletions(-)

diff --git a/Analysis/src/EmbeddedBuiltinDefinitions.cpp b/Analysis/src/EmbeddedBuiltinDefinitions.cpp
index 0f04ace0..67abbff1 100644
--- a/Analysis/src/EmbeddedBuiltinDefinitions.cpp
+++ b/Analysis/src/EmbeddedBuiltinDefinitions.cpp
@@ -26,34 +26,34 @@ declare bit32: {
 }
 
 declare math: {
-    frexp: (number) -> (number, number),
-    ldexp: (number, number) -> number,
-    fmod: (number, number) -> number,
-    modf: (number) -> (number, number),
-    pow: (number, number) -> number,
-    exp: (number) -> number,
+    frexp: (n: number) -> (number, number),
+    ldexp: (s: number, e: number) -> number,
+    fmod: (x: number, y: number) -> number,
+    modf: (n: number) -> (number, number),
+    pow: (x: number, y: number) -> number,
+    exp: (n: number) -> number,
 
-    ceil: (number) -> number,
-    floor: (number) -> number,
-    abs: (number) -> number,
-    sqrt: (number) -> number,
+    ceil: (n: number) -> number,
+    floor: (n: number) -> number,
+    abs: (n: number) -> number,
+    sqrt: (n: number) -> number,
 
-    log: (number, number?) -> number,
-    log10: (number) -> number,
+    log: (n: number, base: number?) -> number,
+    log10: (n: number) -> number,
 
-    rad: (number) -> number,
-    deg: (number) -> number,
+    rad: (n: number) -> number,
+    deg: (n: number) -> number,
 
-    sin: (number) -> number,
-    cos: (number) -> number,
-    tan: (number) -> number,
-    sinh: (number) -> number,
-    cosh: (number) -> number,
-    tanh: (number) -> number,
-    atan: (number) -> number,
-    acos: (number) -> number,
-    asin: (number) -> number,
-    atan2: (number, number) -> number,
+    sin: (n: number) -> number,
+    cos: (n: number) -> number,
+    tan: (n: number) -> number,
+    sinh: (n: number) -> number,
+    cosh: (n: number) -> number,
+    tanh: (n: number) -> number,
+    atan: (n: number) -> number,
+    acos: (n: number) -> number,
+    asin: (n: number) -> number,
+    atan2: (y: number, x: number) -> number,
 
     min: (number, ...number) -> number,
     max: (number, ...number) -> number,
@@ -61,13 +61,13 @@ declare math: {
     pi: number,
     huge: number,
 
-    randomseed: (number) -> (),
+    randomseed: (seed: number) -> (),
     random: (number?, number?) -> number,
 
-    sign: (number) -> number,
-    clamp: (number, number, number) -> number,
-    noise: (number, number?, number?) -> number,
-    round: (number) -> number,
+    sign: (n: number) -> number,
+    clamp: (n: number, min: number, max: number) -> number,
+    noise: (x: number, y: number?, z: number?) -> number,
+    round: (n: number) -> number,
 }
 
 type DateTypeArg = {