backend-server icon indicating copy to clipboard operation
backend-server copied to clipboard

Add Documentation to Duck Generator Library

Open William-McGonagle opened this issue 2 years ago • 0 comments

Idea

The duck generator is a really great system, but the only problem is that there is no documentation for it. All of the code for the file can be found inside of the src/routes/Duck/ folder. This is where all of the code for generating ducks can be found, but it all needs to be documented so it can be easily understood for new members of the project.

Todo

  • [ ] Add some information about how duck strings are stored
    • [ ] Show what hex numbers mean what
    • [ ] This issue has some information about that - #38
  • [ ] duckGenerator.js
    • [ ] Document the parseDuckString() method
    • [ ] Document the getItemString() method
    • [ ] Document the generateDuck() method

William-McGonagle avatar Dec 28 '21 15:12 William-McGonagle