Merge pull request #707 from Quenty/users/alex-y-z/docs

docs: Fix an assortment of minor issues

Author: alex-y-z

docs/architecture/servicebag.md

@@ -77,7 +77,7 @@ return ServiceName
 
 There are 3 methods in a service that are precoded in a `ServiceBag`.
 
-All three of these services are optional. However, if you want to have services
+All three of these methods are optional. However, if you want to have services
 bootstrapped that this service depends upon, then you should do this in `Init`.
 
 ### `ServiceBag:Init(serviceBag)`
@@ -210,8 +210,7 @@ end
 Nevermore tries to be a collection of libraries that can be plugged together,
 and not exist as a set framework that forces specific design decisions. While
 there are certainly some design patterns these libraries will guide you to,
-you shouldn't necessarily feel forced to operate within these set of
-scenarios.
+you shouldn't necessarily feel forced to operate within this set of scenarios.
 
 That being said, in order to use certain services, like `CmdrService` or
 permission service, you need to be familiar with `ServiceBag`.

docs/build.md

@@ -50,7 +50,7 @@ There are some additional ideas worth reviewing which are relatively unique to t
 
 In general, our CHANGELOG.md are generated by our commits, which also dictates our semantic versioning.
 
-## Get the repo setup to develop locally.
+## Get the repo setup to develop locally
 Unlike consuming Nevermore, building and changing Nevermore for general production is a little bit trickier. This is because:
 
 1. Unlike consuming, we want changes to show up immediately so we can test everything at once.

src/actionmanager/src/Client/BaseAction.lua

@@ -3,7 +3,7 @@
 	BaseAction state for [ActionManager].
 
 	:::info
-	This is legacy code and probably shoudl not be used in new games.
+	This is legacy code and probably should not be used in new games.
 	:::
 
 	@class BaseAction

src/adorneedata/src/Shared/AdorneeData.lua

@@ -25,7 +25,7 @@
 	```lua
 	local data = CombatConfiguration:Create(workspace)
 
-	-- Can ready any data
+	-- Can read any data
 	print(data.EnableCombat.Value) --> true
 	print(data.PunchDamage.Value) --> 15
 	print(data.Value) --> { EnableCombat = true, PunchDamage = true }

src/animationgroup/src/Shared/AnimationGroupUtils.lua

@@ -1,7 +1,7 @@
 --!strict
 --[=[
 	An animation group is a group of animations, such as the idle animations that Roblox plays.
-	This utility functions are intended to help recreate a custom animation playback system with
+	These utility functions are intended to help recreate a custom animation playback system with
 	weighted values.
 	@class AnimationGroupUtils
 ]=]

src/attributeutils/src/Shared/AttributeValue.lua

@@ -70,7 +70,7 @@ function AttributeValue.new<T>(object: Instance, attributeName: string, defaultV
 end
 
 --[=[
-	Handles observing the value conditionalli
+	Handles observing the value conditionally
 
 	@param condition function | nil
 	@return Observable<Brio<any>>
@@ -91,7 +91,7 @@ function AttributeValue.Observe<T>(self: AttributeValue<T>): Observable.Observab
 end
 
 --[=[
-	The current property of the Attribute. Can be assigned to to write
+	The current property of the Attribute. Can be assigned to write
 	the attribute.
 	@prop Value T
 	@within AttributeValue

src/basicpane/src/Shared/BasicPane.lua

@@ -64,7 +64,7 @@ function BasicPane.new(gui: GuiObject?): BasicPane
 	self._visible = self._maid:Add(ValueObject.new(false, "boolean"))
 
 	--[=[
-		Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which
+		Fires whenever visibility changes. Fires with isVisible, doNotAnimate, and a maid which
 		has the lifetime of the visibility.
 
 		:::info
@@ -120,7 +120,7 @@ end
 --[=[
 	Returns an observable that observes visibility
 
-	@param predicate function | nil -- Optional predicate. If not includeded returns the value.
+	@param predicate function | nil -- Optional predicate. If not included returns the value.
 	@return Observable<Brio<boolean>>
 ]=]
 function BasicPane.ObserveVisibleBrio(

src/bindtocloseservice/package.json

@@ -13,7 +13,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/Quenty/NevermoreEngine.git",
-    "directory": "src/blend/"
+    "directory": "src/bindtocloseservice/"
   },
   "funding": {
     "type": "patreon",

src/blend/src/Shared/Blend/Blend.lua

@@ -49,7 +49,7 @@ export type BlendProps = { [any]: any }
 	```
 
 	@param className string
-	@return (props: { [string]: any; }) -> Observable<Instance>
+	@return (props: { [string]: any }) -> Observable<Instance>
 ]=]
 function Blend.New(className: string): (props: BlendProps) -> Observable.Observable<Instance>
 	assert(type(className) == "string", "Bad className")
@@ -287,7 +287,7 @@ function Blend.Attached(constructor)
 end
 
 --[=[
-	Similiar to Fusion's ComputedPairs, where the changes are cached, and the lifetime limited.
+	Similar to Fusion's ComputedPairs, where the changes are cached, and the lifetime limited.
 	@param source Observable<T> | any
 	@param compute (key: any, value: any, innerMaid: Maid) -> Instance | Observable<Instance>
 	@return Observable<Brio<Instance>>
@@ -669,10 +669,6 @@ end
 	}))
 	```
 
-	:::tip
-
-	:::
-
 	@param className string
 	@return function
 ]=]
@@ -817,10 +813,10 @@ end
 	of multiple. Used in conjunction with [Blend.Children] and [Blend.Computed].
 
 	:::warning
-	In general, cosntructing new instances like this is a bad idea, so it's recommended against it.
+	In general, constructing new instances like this is a bad idea, so it's recommended against it.
 	:::
 
-	```
+	```lua
 	local render = Blend.New "ScreenGui" {
 		Parent = game.Players.LocalPlayer.PlayerGui;
 		[Blend.Children] = {
@@ -832,7 +828,7 @@ end
 					Size = UDim2.fromScale(1, 1);
 					BackgroundTransparency = 0.5;
 				};
-			end)
+			end))
 		};
 	};
 

src/blend/src/Shared/Blend/SpringObject.lua

@@ -134,7 +134,7 @@ function SpringObject:ObserveRenderStepped()
 end
 
 --[=[
-	Alias for [ObserveRenderStepped]
+	Alias for [SpringObject:ObserveRenderStepped]
 
 	@return Observable<T>
 ]=]
@@ -176,7 +176,7 @@ function SpringObject:ObserveVelocityOnRenderStepped()
 end
 
 --[=[
-	Promises that the spring is done, based upon the animating property
+	Promises that the spring is done, based upon the animating property.
 	Relatively expensive.
 
 	@param signal RBXScriptSignal | nil
@@ -437,7 +437,7 @@ function SpringObject:_applyDamper(unconverted: number)
 end
 
 --[=[
-	Sets the damper for the spring
+	Sets the speed for the spring
 
 	@param speed number | Observable<number>
 ]=]