Better code documentation #1
Conversation
bradley-erickson
left a comment
bradley-erickson
left a comment
There was a problem hiding this comment.
All the comments look good and clearly explain the gist of what's going on for each component. I think we just need to address which format we want to use for documenting things. See specifics in code comments.
| * | ||
| * A React component that renders a set of indicator bars, each showing a label, a value, and a help text. | ||
| * The component expects the following props: | ||
| * - id (string): the HTML id of the top-level element. |
There was a problem hiding this comment.
Which format should we use for documentation? This or the @params used elsewhere.
| * - `label` (optional): A label to be used in combination with the highlight ID for customizing styling. | ||
| * @param {string} [class_name] - Additional class name(s) to apply to the rendered component | ||
| * @param {string} [id] - ID to apply to the rendered component | ||
| */ |
There was a problem hiding this comment.
Missing returns statement
| import Button from 'react-bootstrap/Button'; | ||
| import ButtonGroup from 'react-bootstrap/ButtonGroup'; | ||
| import Row from 'react-bootstrap/Row'; | ||
| import Col from 'react-bootstrap/Col'; |
There was a problem hiding this comment.
This component is currently not being used. Changed to using the individual items instead for more modularization. I'd recommend just removing this file (that can wait until we do the migration of the code though)
| * LOConnection is a simple interface to the Learning Observer (LO) | ||
| * WebSocket API. | ||
| * | ||
| * LOConnection is designed to act as a bridge, enabling users to |
There was a problem hiding this comment.
Should the param and return info be included in this comment instead of a subsequent one? Also in whichever format we follow (see other comments)
@bradley-erickson I added documentation to the code as I was stepping through it. Would you mind reviewing? I'm not sure what format you prefer for documentation here.