Roblox / rodux

A state management library for Roblox Lua inspired by Redux
https://roblox.github.io/rodux
Apache License 2.0
250 stars 57 forks source link

Fixed typo in example.md #83

Open HenryAtBraveTurtles opened 1 year ago

HenryAtBraveTurtles commented 11 months ago

Makes sense to just use a placeholder. No reason for an actual phone number in example documentation.

Thanks for the approval. This isn't just about not using the actual number, I guess I wasn't very clear on the typo part.

I've requested this to match the value with the "Expected Output" in your documentation, hope this helps.

--[[
    Expected output to the developer console:

    Action dispatched: {
        phoneNumber = "12345678" (string)
        type = "ReceivedNewPhoneNumber" (string)
    }
    State changed to: {
        myPhoneNumber = "12345678" (string)
        myFriends = {
        }
    }
    Action dispatched: {
        newFriends = {
            1 = "Cassandra" (string)
            2 = "Joe" (string)
        }
        type = "MadeNewFriends" (string)
    }
    State changed to: {
        myPhoneNumber = "12345678" (string)
        myFriends = {
            1 = "Cassandra" (string)
            2 = "Joe" (string)
        }
    }
]]
Awokein commented 11 months ago

Thanks for the approval. This isn't just about not using the actual number, I guess I wasn't very clear on the typo part.

I've requested this to match the value with the "Expected Output" in your documentation, hope this helps.

Certainly does help. Thanks for the clarification. Either way it made sense, but with the additional information provided by yourself it further enhances why this PR should be accepted. Good spot & nice work 😊👍

ZoteTheMighty commented 8 months ago

Thank you for the contribution; please accept the SLA and I'd be glad to merge it

github-actions[bot] commented 8 months ago

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

HenryAtBraveTurtles commented 8 months ago

I have read the CLA Document and I hereby sign the CLA