DevComp/codenamer.luau
1
0
Fork 0
mirror of https://github.com/CompeyDev/codenamer.luau.git synced 2024-12-12 04:40:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(examples): include example descriptions

Browse source
This commit is contained in:
Erica Marigold 2023-08-19 20:53:34 +05:30
parent c74c8a1d01
commit e6a2d39537
No known key found for this signature in database
GPG key ID: 23CD97ABBBCC5ED2
3 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
examples/custom.luau
View file

@ -1,3 +1,10 @@
--[[
examples/custom.luau
Description: A slightly modified version of the simple example, including
custom dictionaries.
]]--
local Codenamer = require("../dist/codenamer")
local stdio = require("@lune/stdio")
local process = require("@lune/process")

8
examples/simple.luau
View file

@ -1,3 +1,11 @@
--[[
examples/simple.luau
Description: A basic codenamer example, which requests the user for a
number of codenames to generate, the way to format them, and
then generates and prints them.
]]--
local Codenamer = require("../dist/codenamer")
local stdio = require("@lune/stdio")
local process = require("@lune/process")

7
examples/tostring.luau
View file

@ -1,3 +1,10 @@
--[[
examples/tostring.luau
Description: Codenamer implements a custom tostring metamethod, which returns a "generic type"
based on the state of the codenamer instance.
]]--
local Codenamer = require("../dist/codenamer")
local codenamer = Codenamer.new()