docs: api root, buildinfo, csp #5493
Conversation
There was a problem hiding this comment.
Spotted a few minor things, but looks good in general.
One thing I'd like to note though is that it'd be nice if we kept Go comments optimized for humans instead of computers/code-gen. I think we can find ways to automatically process the comments into pretty API documentation.
codersdk/updatecheck.go
Outdated
| Version string `json:"version"` | ||
| // URL to download the latest release of Coder. | ||
| URL string `json:"url"` | ||
| } | ||
|
|
||
| // UpdateCheck returns information about the latest release version of | ||
| // Coder and whether or not the server is running the latest release. | ||
| // UpdateCheck returns information about the latest release version of Coder and whether or not the server is running the latest release. |
There was a problem hiding this comment.
These comments are somewhat easier to read when there are line-breaks, why do we need to make them a single line (same for the other changes)? (I personally write mine with <=80 char width but we don't enforce it, sub-80 is most prominent in the project though.)
There was a problem hiding this comment.
I admit that I changed the line length as I stick to <=120 or <=160 chars (widescreen). I believe that times with <=80 chars are already gone :)
As we fixed the bug with <br>, I guess that we can bring the original multi-line comment back.
There was a problem hiding this comment.
😅. For me it's not about the space, I just find long lines harder to read because my eye needs to travel more sideways.
I also admit I like it when comments align closely to the thing they describe 😆 (like this):
There was a problem hiding this comment.
In theory, we could involve one more formatter, golines, to enforce a specific line length limit, but maybe let's leave it aside from this PR.
Related: #3522
Changes:
code tagson paremeters and enums