Uploaded image for project: 'Apache YuniKorn'
  1. Apache YuniKorn
  2. YUNIKORN-665

Make comments in code conform to Godoc conventions

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:
      None

      Description

      The comments in all the repos (core, k8shim and interface) do not follow the Godoc conventions. We should reformat them to align with those conventions. It will offer several benefits:

      • Godoc can be used to "generate documentation in a variety of formats, from plain text to HTML to UNIX man pages, and makes it read better when tools truncate it for brevity, such as when they extract the first line or sentence."
      • Avoid warnings from IDEs like Goland.
      • "Godoc comments are just good comments, the sort you would want to read even if godoc didn't exist."

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              yuchaoran2011 Chaoran Yu
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: