Generalized game sheets to a reusable template#73
Conversation
Created game-sheet directory in UI folder Sheet can be used for other purposes
| }; | ||
|
|
||
| /** | ||
| * Template predicate to determine if game is Japanese style |
There was a problem hiding this comment.
@amrocha Do you think I'm overdoing the function documentation?
There was a problem hiding this comment.
Hmm yeah I think for like, self-evident function like this one it would be fine to not have anything, but you have type information there which really helps in vanilla JS so I think it adds something
There was a problem hiding this comment.
I have no idea how useful type information is. I commented some of the functions in detail, and some I left uncommented. Which is better?
There was a problem hiding this comment.
Is this in preparation for other people to take over maintenance of the system? For example, in lines 60-181 it's hard to keep track of the code and see the big idea with the comments in between. If it's for people to sift through and figure out though, this much documentation may be necessary.
There was a problem hiding this comment.
Yeah, I'm not going to be around forever so I think it might be important. Do you think it takes too much away?
There was a problem hiding this comment.
Give me a day or two, I'm gonna download it and try looking at it without as much documentation.
There was a problem hiding this comment.
With some editor setups you should be able to collapse comments
|
@TwelveNights @Mooters @amrocha What do you think of the level of documentation here? Is it too much, or just enough for someone who is unfamiliar with the code? |
chllarry
left a comment
chllarry
left a comment
There was a problem hiding this comment.
I think it clarifies the code lot more, and the formatting makes it easier to understand though not exactly easier to read. Still a good change overall for people unfamiliar with code or the way the menu works
5 participants
Created this to make showing current games and displaying server-side games easier. Just wanted to see what you thought about it.