Page MenuHomePhabricator

Add docstrings to ChessBrowser JS module
Open, Needs TriagePublic

Description

The ChessBrowser JavaScript module lacks docstrings describing the functions and their roles. This makes it difficult to understand and hard to maintain for those not already familiar with the code.

See the MediaWiki coding conventions for more info on how to format the docstrings.

At minimum the doc strings should describe:

  • in a sentence, what the function does
  • Parameter types, names, and basic description
  • Return type(s)
  • Any errors raised and what would cause them