Skip to content

Change function description comments to tsdoc style #35185

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 31, 2025
Merged

Change function description comments to tsdoc style #35185

merged 3 commits into from
Jul 31, 2025
+36 −36

Conversation

@silverwind
Copy link
Member

@silverwind silverwind commented Jul 30, 2025 •
edited
Loading

  1. change function comments to the minimal tsdoc style. This has the benefit of making editors show the doc string in tooltips when the function is hovered:
image
  1. disable eslint multiline-comment-style as it conflicts with tsdoc.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 30, 2025
@silverwind silverwind added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Jul 30, 2025
@silverwind silverwind changed the title Change function description comments in typescript to tsdoc style Change function description comments to tsdoc style Jul 30, 2025
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 30, 2025
silverwind
silverwind commented Jul 30, 2025
View reviewed changes
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jul 31, 2025
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jul 31, 2025
@lunny lunny merged commit f4d7701 into go-gitea:main Jul 31, 2025
26 checks passed
@GiteaBot GiteaBot added this to the 1.25.0 milestone Jul 31, 2025
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jul 31, 2025
@silverwind silverwind deleted the tsdoccomments branch July 31, 2025 23:26
zjjhot added a commit to zjjhot/gitea that referenced this pull request Aug 1, 2025
@zjjhot
Merge remote-tracking branch 'giteaofficial/main'
0ce470e 
* giteaofficial/main:
  Update JS and PY deps (go-gitea#35191)
  [skip ci] Updated translations via Crowdin
  Change function description comments to tsdoc style (go-gitea#35185)
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Oct 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@lunny lunny lunny approved these changes

@delvh delvh delvh approved these changes

Assignees

No one assigned

Labels

lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/frontend modifies/internal skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. topic/code-linting

Projects

None yet

Milestone

1.25.0

Development

Successfully merging this pull request may close these issues.

4 participants

@silverwind @lunny @delvh @GiteaBot