Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: api root, buildinfo, csp#5493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
mtojek merged 31 commits intocoder:mainfrommtojek:3522-document-more-methods-2
Dec 22, 2022

Conversation

mtojek
Copy link
Member

@mtojekmtojek commentedDec 21, 2022
edited
Loading

Related:#3522

Changes:

  • docs: API root handler, buildinfo, csp
  • fix: updatecheck security
  • fix:code tags on paremeters and enums

@mtojekmtojek self-assigned thisDec 21, 2022
@mtojekmtojek marked this pull request as ready for reviewDecember 21, 2022 15:43
@mtojekmtojek changed the titledocs: TBDdocs: api root, buildinfo, cspDec 21, 2022
Copy link
Member

@mafredrimafredri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.)

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

😅. 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):
image

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link
Member

@mafredrimafredri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM! 👍

@mtojekmtojek merged commitcfd02d9 intocoder:mainDec 22, 2022
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsDec 22, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@mafredrimafredrimafredri approved these changes

@bpmctbpmctbpmct approved these changes

Assignees

@mtojekmtojek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@mtojek@mafredri@bpmct

[8]ページ先頭

©2009-2025 Movatter.jp