Skip to content

Stuff to document #545

@Seanny123

Description

@Seanny123
  • The htmlview.js documentation makes no sense.
  • The Python components should at least have a quick header describing their purpose
  • user_action.py
  • netgraph.py
  • ipython.py
  • sim_control.py, especially what the control function and node is doing
  • sim_control.js, message handling. In particular, how config is only used for modal back-end selection. Is it intended for other things as well?
  • Note that we follow the Google style guide, but that we also have our own rules from commenting based off of Python
  • Make a jscs configuration file
  • The parent parameter of most of the components isn't documented
  • A few of Terry's tutorial examples could use more comments in the code, especially the first one with the slowdown node.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions