search

1ForeverHD / TopbarPlus

Construct dynamic and intuitive topbar icons. Enhance the appearance and behaviour of these icons with features such as themes, dropdowns and menus.
https://devforum.roblox.com/t/topbarplus/1017485
Mozilla Public License 2.0
95 stars 123 forks source link

Inconsistency in variable names [DOCUMENTS] #44

Closed cens6r closed 2 years ago

cens6r commented 2 years ago

In the introduction section, the docs uses the variable name "Icon" to require the module.

local Icon = require(game:GetService("ReplicatedStorage").Icon)

However, in the features section, the docs uses the variable name "iconModule" to require the module.

local iconModule = game:GetService("ReplicatedStorage").Icon

I believe small inconsistencies like this are critical in documents that a large number of users view and I think it would be easier for everyone for this issue to be fixed!

Thanks for the awesome module btw

1ForeverHD commented 2 years ago

This is intentional: iconModule is referencing a module instance, while Icon is referencing the return value of that module after being required. I think you might be confusing them as the same thing.

No problem, glad it comes in use!