Unannotated local function diagnostic #3300
Conversation
…missing-local-doc
…mentation for missing-local-doc
NathanSnail
changed the title
Summary of ChangesHello @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, Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
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 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 up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
locale/en-us/script.lua
Outdated
| 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 `{}`.' |
There was a problem hiding this comment.
These diagnostic message definitions are duplicated. The first block also contains TODO: need translate! comments, which are not necessary for the en-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", |
There was a problem hiding this comment.
There seems to be a copy-paste error here. The diagnostic name should be missing-local-doc to match the comment above, but it's written as missing-local-export-doc. This also creates a duplicate key in this configuration block, as missing-local-export-doc is defined again on line 882.
| "missing-local-export-doc": "None", | |
| "missing-local-doc": "None", |
|
I'm not sure how to run |
1 participant
Currently you can check this for global functions and exported locals but not normal locals. This adds this (disabled by default).