Skip to content

Conversation

@phanen
Copy link
Contributor

@phanen phanen commented Nov 2, 2025

I'm using emmylua_doc_cli to generate docs for a nvim plugin.
This is a quick fix for missing boolean literal.

@gemini-code-assist
Copy link

Summary of Changes

Hello @phanen, 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 emmylua_doc_cli utility by ensuring that boolean literal values are properly rendered when generating documentation. This fix improves the accuracy and completeness of the output, particularly for users documenting Neovim plugins or other Lua projects where boolean constants are used.

Highlights

  • Boolean Literal Generation: The emmylua_doc_cli tool has been updated to correctly generate documentation for boolean literal constants, addressing a previously missing case in its rendering logic.
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 👍 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

  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.

Copy link

@gemini-code-assist gemini-code-assist bot 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 adds support for generating boolean literals in emmylua_doc_cli. The change is straightforward, adding a new case for LuaType::BooleanConst in the render_const function. However, the implementation seems incomplete as it misses the LuaType::DocBooleanConst variant. I've added a suggestion to include it for consistency and correctness, similar to how other constant types are handled.

LuaType::StringConst(s) | LuaType::DocStringConst(s) => {
Some(format!("{:?}", s.to_string()))
}
LuaType::BooleanConst(b) => Some(b.to_string()),

Choose a reason for hiding this comment

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

high

This is a good addition, but it seems to be incomplete. The LuaType enum also has a DocBooleanConst variant, which should probably be handled here as well, similar to how DocIntegerConst and DocStringConst are handled in the same function.

Suggested change
LuaType::BooleanConst(b) => Some(b.to_string()),
LuaType::BooleanConst(b) | LuaType::DocBooleanConst(b) => Some(b.to_string()),

@CppCXY CppCXY merged commit df7a12d into EmmyLuaLs:main Nov 3, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants