Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • RAPID-MIX_API RAPID-MIX_API
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 31
    • Issues 31
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • rapid-mix
  • RAPID-MIX_APIRAPID-MIX_API
  • Issues
  • #28

Closed
Open
Created Sep 20, 2017 by Francisco Bernardo@franciscoOwner

Self-explanatory code and commenting practices

Users considered code comments as important as documentation. Code comments compete with the main documentation, particularly for certain users who bypassed documentation completely, or who prefer to refer to it much later in the exploration and development workflow, for troubleshooting for instance.

Recommendations:

  • Examples' code should be comprehensively commented in sections with “magic numbers” (e.g. number 5 in RapidStream, number of Gaussians, etc.)"
  • Examples such as the RapidStream would benefit from adding the rationale and usefulness for each feature in the UI.
Assignee
Assign to
Time tracking