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

Unannotated local function diagnostic#3300

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

Draft
NathanSnail wants to merge7 commits intoLuaLS:master
base:master
Choose a base branch
Loading
fromNathanSnail:unannotated_function_diagnostic

Conversation

@NathanSnail
Copy link
Contributor

Currently you can check this for global functions and exported locals but not normal locals. This adds this (disabled by default).

@NathanSnailNathanSnail changed the titleUnannotated function diagnosticUnannotated local function diagnosticDec 2, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello@NathanSnail, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the static analysis capabilities by introducing a new diagnostic,missing-local-doc, which specifically targets local functions lacking proper documentation. This feature aims to improve code quality and maintainability by encouraging comprehensive annotation of all function types, ensuring consistency with existing checks for global and exported local functions.

Highlights

  • New Diagnostic:missing-local-doc: A new diagnostic has been introduced to identify local functions that are missing comments, parameter annotations, or return annotations. This expands the existing documentation checks beyond global and exported local functions.
  • Default Disabled: The newly addedmissing-local-doc diagnostic is disabled by default, allowing users to opt-in to this check as needed.
  • Localization Support: Messages for the new diagnostic have been added across various language locales, though some translations are marked as 'TODO' and will require future updates.
  • Comprehensive Testing: Dedicated test cases have been added to ensure the correct functionality and detection of undocumented local functions by the new diagnostic.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on ourdocumentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either/gemini <command> or@gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

FeatureCommandDescription
Code Review/gemini reviewPerforms a code review for the current pull request in its current state.
Pull Request Summary/gemini summaryProvides a summary of the current pull request in its current state.
Comment@gemini-code-assistResponds in comments when explicitly tagged, both in pull request comments and review comments.
Help/gemini helpDisplays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a.gemini/ folder in the base of the repository. Detailed instructions can be foundhere.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on@gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign uphere.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with theGemini Code Assist IDE Extension.

Footnotes

  1. Review thePrivacy Notices,Generative AI Prohibited Use Policy,Terms of Service, and learn how to configure Gemini Code Assist in GitHubhere. Gemini can make mistakes, so double check it anduse code with caution.↩

Copy link

@gemini-code-assistgemini-code-assistbot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new diagnostic for unannotated local functions, which is a great addition for improving code documentation. The implementation and tests look solid. I've found a couple of minor copy-paste errors in the documentation and locale files that should be addressed. Overall, this is a good contribution.

Comment on lines 129 to 140
DIAG_MISSING_LOCAL_DOC_COMMENT=-- TODO: need translate!
'Missing comment for local function `{}`.'
DIAG_MISSING_LOCAL_DOC_PARAM=-- TODO: need translate!
'Missing @param annotation for parameter `{}` in local function `{}`.'
DIAG_MISSING_LOCAL_DOC_RETURN=-- TODO: need translate!
'Missing @return annotation at index `{}` in local function `{}`.'
DIAG_MISSING_LOCAL_DOC_COMMENT=
'Missing comment for local function `{}`.'
DIAG_MISSING_LOCAL_DOC_PARAM=
'Missing @param annotation for parameter `{}` in local function `{}`.'
DIAG_MISSING_LOCAL_DOC_RETURN=
'Missing @return annotation at index `{}` in local function `{}`.'

Choose a reason for hiding this comment

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

high

These diagnostic message definitions are duplicated. The first block also containsTODO: need translate! comments, which are not necessary for theen-us locale. This can be cleaned up by removing the duplicate block and the TODO comments.

DIAG_MISSING_LOCAL_DOC_COMMENT        ='Missing comment for local function `{}`.'DIAG_MISSING_LOCAL_DOC_PARAM          ='Missing @param annotation for parameter `{}` in local function `{}`.'DIAG_MISSING_LOCAL_DOC_RETURN         ='Missing @return annotation at index `{}` in local function `{}`.'

/*
Missing annotations for locals! Local functions must have a comment and annotations for all parameters and return values.
*/
"missing-local-export-doc":"None",

Choose a reason for hiding this comment

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

medium

There seems to be a copy-paste error here. The diagnostic name should bemissing-local-doc to match the comment above, but it's written asmissing-local-export-doc. This also creates a duplicate key in this configuration block, asmissing-local-export-doc is defined again on line 882.

Suggested change
"missing-local-export-doc": "None",
"missing-local-doc": "None",

@NathanSnail
Copy link
ContributorAuthor

I'm not sure how to runbuild-doc.lua, so that needs doing.

@NathanSnailNathanSnail marked this pull request as draftDecember 2, 2025 12:22
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

1 more reviewer

@gemini-code-assistgemini-code-assist[bot]gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@NathanSnail
[8]ページ先頭
©2009-2025 Movatter.jp