Skip to content

fix: stdlib success return types#3386

Open
haithium wants to merge 3 commits intoLuaLS:masterfrom
haithium:master
Open

fix: stdlib success return types#3386
haithium wants to merge 3 commits intoLuaLS:masterfrom
haithium:master

Conversation

@haithium
Copy link

No description provided.

@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 focuses on improving the consistency and clarity of return types in the standard library, specifically within the io and os modules. By changing the success return type to true? and adding an optional error code for os.remove and os.rename, the PR aims to provide more precise and informative feedback to users of these functions.

Highlights

  • Return Type Consistency: This PR standardizes the return types for success in io and os library functions to true?.
  • Enhanced Error Information: The os.remove and os.rename functions now include an optional errcode return value for more detailed error reporting.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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 refines the return type annotations for several standard library functions in io.lua and os.lua. The changes correctly replace the generic boolean or boolean? with the more specific true? for success return values, which accurately reflects that these functions return true on success and nil on failure. Additionally, for os.remove and os.rename, the annotations are improved by correcting the nullability of the success return value and adding the missing errcode integer that is returned on failure. These changes improve the accuracy and precision of the type definitions, which is beneficial for static analysis.

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.

1 participant