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

Code docs #45

Merged
merged 20 commits into from Aug 21, 2018

Conversation

Projects
None yet
3 participants
@kenthinson
Contributor

kenthinson commented Aug 17, 2018

Some docs I wrote for today. I will continue as time allows.

Show outdated Hide outdated Sources/iron/data/Data.hx Outdated
@sh-dave

This comment has been minimized.

Show comment
Hide comment
@sh-dave

sh-dave Aug 17, 2018

Contributor

Cool! Personally, i'd remove most of the Optional (default is true/false) and the type of return value though, as your IDE will already give you that info.

Contributor

sh-dave commented Aug 17, 2018

Cool! Personally, i'd remove most of the Optional (default is true/false) and the type of return value though, as your IDE will already give you that info.

@kenthinson

This comment has been minimized.

Show comment
Hide comment
@kenthinson

kenthinson Aug 17, 2018

Contributor

Thanks will fix it. Too bad spell check does not work in Kode Studio. I might have to write everything in a different software then copy and paste

Contributor

kenthinson commented Aug 17, 2018

Thanks will fix it. Too bad spell check does not work in Kode Studio. I might have to write everything in a different software then copy and paste

@sh-dave

This comment has been minimized.

Show comment
Hide comment
@sh-dave

sh-dave Aug 17, 2018

Contributor

Instead of KS, you can also use plain vscode with the kha extension pack. That way you can also install other extensions like a spellchecker. It's also possible in KS, but you have to install the extensions manually.

Contributor

sh-dave commented Aug 17, 2018

Instead of KS, you can also use plain vscode with the kha extension pack. That way you can also install other extensions like a spellchecker. It's also possible in KS, but you have to install the extensions manually.

@kenthinson

This comment has been minimized.

Show comment
Hide comment
@kenthinson

kenthinson Aug 17, 2018

Contributor

@sh-dave Yeah the reason I have that optional info is for new programmers. Trying to make it noob friendly. I mean you and I can read the code and figure out what it's doing but I figured the docs should spell it out in plain English. What do you think of that idea?

Contributor

kenthinson commented Aug 17, 2018

@sh-dave Yeah the reason I have that optional info is for new programmers. Trying to make it noob friendly. I mean you and I can read the code and figure out what it's doing but I figured the docs should spell it out in plain English. What do you think of that idea?

@kenthinson

This comment has been minimized.

Show comment
Hide comment
@kenthinson

kenthinson Aug 17, 2018

Contributor

@sh-dave I'll try to get that working. Thanks

EDIT: got VS Code working now sweet! :)

Contributor

kenthinson commented Aug 17, 2018

@sh-dave I'll try to get that working. Thanks

EDIT: got VS Code working now sweet! :)

@sh-dave

This comment has been minimized.

Show comment
Hide comment
@sh-dave

sh-dave Aug 17, 2018

Contributor

Hm, but you don't actually have to read the code in most cases (with the exception of parent parameter in spawnObject where i think mentioning it is actually good). And most newbies will probably use armory without even knowing iron or what it is to begin with. But i don't have that strong feelings about the comments being there, so do what you think is best 😃

Contributor

sh-dave commented Aug 17, 2018

Hm, but you don't actually have to read the code in most cases (with the exception of parent parameter in spawnObject where i think mentioning it is actually good). And most newbies will probably use armory without even knowing iron or what it is to begin with. But i don't have that strong feelings about the comments being there, so do what you think is best 😃

@kenthinson

This comment has been minimized.

Show comment
Hide comment
@kenthinson

kenthinson Aug 17, 2018

Contributor

@sh-dave thanks for the feedback :) I think I will air on the side of too verbose then on the side of not enough info. After all we can just ignore it and keep coding. Unless @luboslenco has a issue with that. I'm teaching my nephew how to program Using Armory. Seeing all his questions has really opened my eyes to how things I take for granted aren't for others

Contributor

kenthinson commented Aug 17, 2018

@sh-dave thanks for the feedback :) I think I will air on the side of too verbose then on the side of not enough info. After all we can just ignore it and keep coding. Unless @luboslenco has a issue with that. I'm teaching my nephew how to program Using Armory. Seeing all his questions has really opened my eyes to how things I take for granted aren't for others

@luboslenco luboslenco merged commit 3aab16d into armory3d:master Aug 21, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@luboslenco

This comment has been minimized.

Show comment
Hide comment
@luboslenco

luboslenco Aug 21, 2018

Member

Thanks a lot!

Member

luboslenco commented Aug 21, 2018

Thanks a lot!

@kenthinson

This comment has been minimized.

Show comment
Hide comment
@kenthinson

kenthinson Aug 21, 2018

Contributor

@luboslenco I will add more as I have time. Glad to help this awesome project :)

Contributor

kenthinson commented Aug 21, 2018

@luboslenco I will add more as I have time. Glad to help this awesome project :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment