lua-language-server icon indicating copy to clipboard operation
lua-language-server copied to clipboard

Unannotated local function diagnostic

Open NathanSnail opened this issue 1 month ago • 2 comments

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

NathanSnail avatar Dec 02 '25 09:12 NathanSnail

Summary of Changes

Hello @NathanSnail, I'm Gemini Code Assist[^1]! 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 added missing-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 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays 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 found here.

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 :thumbsup: and :thumbsdown: 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.

[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

gemini-code-assist[bot] avatar Dec 02 '25 09:12 gemini-code-assist[bot]

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

NathanSnail avatar Dec 02 '25 10:12 NathanSnail