Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Document the use of meta methods for client.playerList #22

Open
Seniru opened this issue May 22, 2020 · 0 comments
Open

[Docs] Document the use of meta methods for client.playerList #22

Seniru opened this issue May 22, 2020 · 0 comments
Labels
Important /!\ Requires attention /!\

Comments

@Seniru
Copy link
Contributor

Seniru commented May 22, 2020 •
edited
Loading

https://github.com/Lautenschlager-id/Transfromage/blob/cb699b5bea9c157f1f1f2c46178b49af8f3918ef/libs/client.lua#L111

According to libs/client.lua#L111, the field playerList is associated with a meta table which defines the meta methods __len and __pairs, which of course allows us to do operations like #client.playerList and pairs(client.playerList)

But as far as I can see, those meta methods are not documented

In my opinion it would be easier for both users and developers if they are documented
@Lautenschlager-id Lautenschlager-id added the Important /!\ Requires attention /!\ label May 23, 2020
@Seniru Seniru changed the title [DOCS] Document the use of pairs for client.playerList [Docs] Document the use of meta methods for client.playerList May 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Important /!\ Requires attention /!\
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Lautenschlager-id @Seniru