Skip to content

Conversation

@dljsjr
Copy link

@dljsjr dljsjr commented Dec 4, 2025

name and file don't appear to be guaranteed non-nil; because of this, if there are cases where the key is present on one element but not the other, the equality check will fall through to the less-than check and this results in a crash comparing string against nil.

Resolves: #3111

`name` and `file` don't appear to be guaranteed non-nil; because of this, if there are cases where the key is present on one element but not the other, the equality check will fall through to the  less-than check and this results in a crash comparing `string` against `nil`.

Resolves: LuaLS#3111
@gemini-code-assist
Copy link

Summary of Changes

Hello @dljsjr, 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 stability of the documentation sorting mechanism by implementing nil checks in the export.sortDoc function. Previously, the sorting logic could encounter runtime errors when attempting to compare nil values with strings for the name or file properties. The changes prevent these crashes by ensuring that comparisons are only performed when both operands are valid, thereby resolving a reported issue and improving the overall reliability of the documentation generation process.

Highlights

  • Nil Checks for Sorting: Introduced explicit nil checks for name and file properties within the export.sortDoc function to prevent runtime errors when comparing potentially nil values against strings.
  • Crash Prevention: Addressed a reported issue where the sorting logic could crash if one of the elements being compared had a nil value for name or file, while the other had a string, resolving issue Cannot export neovim runtime doc #3111.
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

The pull request modifies the export.sortDoc function in script/cli/doc/export.lua to include nil checks for a.name, b.name, a.file, and b.file before performing comparisons. This change enhances the robustness of the sorting logic by preventing potential errors if these properties are nil on the objects being sorted.

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.

Cannot export neovim runtime doc

1 participant