@quenty/rotatinglabel 4.0.0 → 4.1.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.1.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rotatinglabel@4.0.1...@quenty/rotatinglabel@4.1.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/rotatinglabel
+
+
+
+
+
+## [4.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rotatinglabel@4.0.0...@quenty/rotatinglabel@4.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/rotatinglabel
+
+
+
+
+
 # [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rotatinglabel@3.4.0...@quenty/rotatinglabel@4.0.0) (2021-12-22)
 
 **Note:** Version bump only for package @quenty/rotatinglabel

package/README.md

@@ -1,10 +1,10 @@
 ## RotatingLabel
 <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" />
@@ -15,6 +15,8 @@ A text label with most general properties of a textlabel, except when text is se
 
 This is relatively legacy code and so probably should be carefully considered before using in a new project.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RotatingLabel">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/rotatinglabel --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rotatinglabel",
-  "version": "4.0.0",
+  "version": "4.1.0-canary.241.a4e8214.0",
   "description": "A text label with most general properties of a textlabel, except when text is set, it rotates uniformly like an old clock, animating in a satisfying way",
   "keywords": [
     "Roblox",
@@ -25,12 +25,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/math": "^2.0.0",
-    "@quenty/spring": "^3.0.0"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
+    "@quenty/math": "2.0.1",
+    "@quenty/spring": "3.1.0-canary.241.a4e8214.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3a3d03785e31c5b53d27d1fff519a53c695fbc19"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Client/RotatingCharacter.lua

@@ -1,5 +1,7 @@
---- Character that rotates for animations
--- @classmod RotatingCharacter
+--[=[
+	Character that rotates for animations
+	@class RotatingCharacter
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/RotatingCharacterBuilder.lua

@@ -1,5 +1,6 @@
----
--- @classmod RotatingCharacterBuilder
+--[=[
+	@class RotatingCharacterBuilder
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/RotatingLabel.lua

@@ -1,6 +1,13 @@
---- A text label with most general properties of a textlabel, except when text is set,
--- it rotates uniformly like an old clock, animating in a satisfying way
--- @usage Construct with RotatingLabelBuilder.new(Template):Create()
+--[=[
+	A text label with most general properties of a textlabel, except when text is set,
+	it rotates uniformly like an old clock, animating in a satisfying way
+
+	``lua
+	RotatingLabelBuilder.new(Template):Create()
+	```
+
+	@class RotatingLabel
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -98,7 +105,7 @@ function RotatingLabel:__index(index)
 	end
 end
 
----
+--
 -- @usage
 --[[
 	RotatingLabel.Text = string

package/src/Client/RotatingLabelBuilder.lua

@@ -1,5 +1,12 @@
---- Builds a new RotatingLabel. See RotatingLabel for more details.
--- @classmod RotatingLabelBuilder
+--[=[
+	Builds a new RotatingLabel. See RotatingLabel for more details.
+
+	:::warning
+	This class is not really maintained or used anymore.
+	:::
+
+	@class RotatingLabelBuilder
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,7 +16,7 @@ local RotatingLabelBuilder = {}
 RotatingLabelBuilder.ClassName = "RotatingLabelBuilder"
 RotatingLabelBuilder.__index = RotatingLabelBuilder
 
---- Starts building a new rotating label with the template, if given
+-- Starts building a new rotating label with the template, if given
 function RotatingLabelBuilder.new(template)
 	local self = setmetatable({}, RotatingLabelBuilder)
 
@@ -20,7 +27,7 @@ function RotatingLabelBuilder.new(template)
 	return self
 end
 
---- Sets the tempate to use, the label will get those properties
+-- Sets the tempate to use, the label will get those properties
 function RotatingLabelBuilder:WithTemplate(template)
 	self._template = template
 
@@ -58,7 +65,7 @@ function RotatingLabelBuilder:WithGui(gui)
 	return self
 end
 
---- Creates the new label and returns it
+-- Creates the new label and returns it
 function RotatingLabelBuilder:Create()
 	self._label:UpdateRender()