search

johnfraserss / ICS4U

ICS4U Course for John Fraser SS
MIT License
23 stars 32 forks source link

Go Examples #36

Closed AritroSaha10 closed 6 months ago

AritroSaha10 commented 1 year ago
AritroSaha10 commented 1 year ago

@mrseidel finished all the examples, it should be ready to merge?

AritroSaha10 commented 1 year ago

@mrseidel Sorry, could you look over this when you get the chance?

mrseidel commented 1 year ago

With a quick review, it looks like there is a lack of comments in the Objects, Documentation, and Extending Objects section. I do understand that struct is required, but if you could add in comments for each of these sections similar to how they would exist for classes for consistency across the different language examples.

Will continue reviewing over the next week.

AritroSaha10 commented 1 year ago

Sounds good, I'll work on adding comments to those sections. Although, I'm not sure what comments to add for the documentation section since function documentation conventions in Go looks to be pretty basic (just needs to explain what the function returns, ref: https://tip.golang.org/doc/comment, Funcs section)

mrseidel commented 1 year ago

Take a look at the other examples and you can do something similar - at least a description. If it's a function with parameters and/or return values, include those.

That's usually a sufficient minimum for what has occurred for the other language examples on here.

AritroSaha10 commented 1 year ago

i've added comments for all the examples you've mentioned. i tried to add comments similar to the other examples but it looks like most of them don't have many. let me know if i should add more documentation

AritroSaha10 commented 1 year ago

Resolved everything to my knowledge. Let me know what else I should change.

AritroSaha10 commented 1 year ago

@mrseidel Sorry, could you look over this again by chance?

AritroSaha10 commented 1 year ago

@mrseidel Sorry to disturb, just bumping this in case if you didn't see.