@quenty/numbersequenceutils 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/numbersequenceutils@2.0.0...@quenty/numbersequenceutils@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/numbersequenceutils
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/numbersequenceutils@1.2.0...@quenty/numbersequenceutils@2.0.0) (2021-09-05)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## NumberSequenceUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,15 +13,9 @@
 
 Utility functions involving NumberSequences on Roblox
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/NumberSequenceUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/numbersequenceutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `NumberSequenceUtils.scale(sequence, scale)`
-
-### `NumberSequenceUtils.stripe(`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/numbersequenceutils",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utility functions involving NumberSequences on Roblox",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/NumberSequenceUtils.lua

@@ -1,10 +1,17 @@
---- Utility functions involving NumberSequences on Roblox
--- @module NumberSequenceUtils
+--[=[
+	Utility functions involving NumberSequences on Roblox
+	@class NumberSequenceUtils
+]=]
 
 local NumberSequenceUtils = {}
 
 local EPSILON = 1e-3
 
+--[=[
+	Scales a number sequence
+	@param sequence NumberSequence
+	@param scale number
+]=]
 function NumberSequenceUtils.scale(sequence, scale)
 	local waypoints = {}
 
@@ -16,6 +23,16 @@ function NumberSequenceUtils.scale(sequence, scale)
 	return NumberSequence.new(waypoints)
 end
 
+--[=[
+	Generates a number sequence with stripes, which can be used in a variety of ways.
+
+	@param stripes number
+	@param backgroundTransparency number -- [0, 1]
+	@param stripeTransparency number -- [0, 1]
+	@param percentStripeThickness number -- [0, 1]
+	@param percentOffset number
+	@return NumberSequence
+]=]
 function NumberSequenceUtils.stripe(
 	stripes, backgroundTransparency, stripeTransparency, percentStripeThickness, percentOffset)