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.

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

Additional class documentation #399

Merged

Conversation

LengthenedGradient
Copy link
Contributor

Following up from the previous documentation update, this one should document the remainder of the base class files.

Copy link
Member

@TwistedTail TwistedTail left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine, just a few missing things and a couple misleading comments in relation to Add*Functions methods.

lua/acf/core/classes/grouped.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/grouped.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/grouped.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/grouped.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/object.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/simple.lua Outdated Show resolved Hide resolved
lua/acf/core/classes/simple.lua Outdated Show resolved Hide resolved
Copy link
Member

@TwistedTail TwistedTail left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine now

@LengthenedGradient
Copy link
Contributor Author

LengthenedGradient commented Apr 13, 2024

I added some documentation to namespaces since they'll be necessary for entity creation. In various places I have things like (objects/simple classes/groups) written. It makes no sense to call them classes because an object is not a class. What else could I call it?

@TwistedTail
Copy link
Member

In various places I have things like (objects/simple classes/groups) written. It makes no sense to call them classes because an object is not a class. What else could I call it?

Personally I would just refer to them as "entries", but I suppose someone else could come up with a better term.

@LengthenedGradient
Copy link
Contributor Author

In various places I have things like (objects/simple classes/groups) written. It makes no sense to call them classes because an object is not a class. What else could I call it?

Personally I would just refer to them as "entries", but I suppose someone else could come up with a better term.

I just went with entries, that should work.

@TwistedTail
Copy link
Member

Anything else you might want to add/change? It seems alright.

@LengthenedGradient
Copy link
Contributor Author

Anything else you might want to add/change? It seems alright.

I think this is ready to be merged. I don't think I'll need to add/change anything else.

@thecraftianman thecraftianman merged commit e97baf6 into ACF-Team:master Apr 14, 2024
2 checks passed
@LengthenedGradient LengthenedGradient deleted the Entity-Documentation branch April 14, 2024 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants