Sugar Labs

Music Blocks: Docstrings for activity.js

Music Blocks has little internal documentation to help the developer. This task is to add docstrings to the myriad of functions in Music Blocks.

A docstring should look approximately like this (placed just above the function):

/*
 * Set the trash flag of each block in a stack as true.
 *
 * @private
 * @param myBlock - A block object at the top of a stack
 * @return {void}
 */
this.sendStackToTrash = function (myBlock) {
};

This specific task is to add docstrings to the functions in actrivity.js

Please contact the mentors if you have any questions regarding the specifics of any individual function.

Task tags

  • javascript
  • docstrings

Students who completed this task

Austin George

Task type

  • chrome_reader_mode Documentation / Training
close

2018