@quenty/metricutils 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/metricutils@2.0.0...@quenty/metricutils@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/metricutils
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/metricutils@1.2.0...@quenty/metricutils@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 @@
 ## MetricUtils
 <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,17 +13,9 @@
 
 Provides ways to convert to or from metric
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/MetricUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/metricutils --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `MetricUtils.getSoundDelaySeconds(studs)`
-
-### `MetricUtils.studsToKilometers(studs)`
-
-### `MetricUtils.studsToMeters(studs)`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/metricutils",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Provides ways to convert to or from metric",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/MetricUtils.lua

@@ -1,6 +1,7 @@
---- Provides ways to convert to or from metric
--- @module MetricUtils
--- @author Quenty
+--[=[
+	Provides ways to convert studs to metric and back.
+	@class MetricUtils
+]=]
 
 local MetricUtils = {}
 
@@ -8,15 +9,30 @@ local STUDS_PER_METER = 3.57
 
 local SPEED_OF_SOUND_IN_METERS_PER_SECOND = 343
 
+--[=[
+	Computes sound delay for the given studs
+	@param studs number
+	@return number -- seconds
+]=]
 function MetricUtils.getSoundDelaySeconds(studs)
 	local meters = MetricUtils.studsToMeters(studs)
 	return meters/SPEED_OF_SOUND_IN_METERS_PER_SECOND
 end
 
+--[=[
+	Converts studs to kilometers
+	@param studs number
+	@return number -- kilometers
+]=]
 function MetricUtils.studsToKilometers(studs)
 	return studs/STUDS_PER_METER/1000
 end
 
+--[=[
+	Converts studs to kilometers
+	@param studs number
+	@return number -- meters
+]=]
 function MetricUtils.studsToMeters(studs)
 	return studs/STUDS_PER_METER
 end