feat: Document Battlesnake Types

GV14982 / tech-friends-battle-snake

MIT License

1 stars 1 forks source link

feat: Document Battlesnake Types #7

Open GV14982 opened 1 year ago

GV14982 commented 1 year ago

Issue Context

It would be a good idea to add inline docs to give some context and hints about what the Battlesnake types mean. Right now we have to context switch between the code and the docs, and it would be nice to have it all in one place.

Proposed solution

Let's add some JSDoc comments to the Battlesnake Types.

Proposed Implementation

No response

Additional Resources

Here is a good cheatsheet on JSDoc: https://devhints.io/jsdoc

Alternatives Considered

No response

sadiejay commented 1 year ago

[x] adding jsdocs to some 😅 of battlesnake object
[x] customization object
[x] ruleset object

subject to change depending on my bandwidth, very flexible haha