You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@yunikorn.apache.org by "Chaoran Yu (Jira)" <ji...@apache.org> on 2021/05/05 23:42:00 UTC

[jira] [Created] (YUNIKORN-665) Make comments in code conform to Godoc conventions

Chaoran Yu created YUNIKORN-665:
-----------------------------------

             Summary: Make comments in code conform to Godoc conventions
                 Key: YUNIKORN-665
                 URL: https://issues.apache.org/jira/browse/YUNIKORN-665
             Project: Apache YuniKorn
          Issue Type: Improvement
          Components: documentation
            Reporter: Chaoran Yu


The comments in all the repos (core, k8shim and interface) do not follow the [Godoc conventions|https://blog.golang.org/godoc]. 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."



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: dev-help@yunikorn.apache.org