enhance os library annotations

[tinyleolin]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @tinyleolin, I'm Gemini Code Assist¹! 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 type annotations within the os library, specifically improving the clarity and precision of date and time-related functions. By introducing a new type std.osdateparam and refining the return type annotations for os.date, the changes aim to provide more robust static analysis and better tooling support for developers working with the os module.

Highlights

• New Type Definition: Introduced std.osdateparam to explicitly define the structure and fields for date/time tables used in the os library.
• Type Inheritance for std.osdate: The std.osdate class now extends std.osdateparam, ensuring consistent and detailed type information for date objects.
• Improved os.date Annotations: Updated the @overload and @return annotations for the os.date function to accurately reflect its return types, specifying std.osdate when a table format is requested and string otherwise.

🧠 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.

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. ↩

[gemini-code-assist]

Code Review

This pull request enhances the EmmyLua annotations for the os library by introducing a std.osdateparam class for os.time and making std.osdate inherit from it. The overloads for os.date are also updated to use the more specific std.osdate type. These are good improvements for type safety and clarity. I've left one comment with suggestions to further improve the correctness and maintainability of the std.osdate class definition.

[gemini-code-assist]

While making std.osdate inherit from std.osdateparam is a good step, there are a couple of follow-up improvements for std.osdate to make the annotations fully correct and maintainable:

1. Redundant fields: The fields year, month, and day (lines 37-39) are now inherited from std.osdateparam and are identical. They can be removed from std.osdate to avoid duplication.
2. Incorrect isdst type: The os.date documentation (line 67) states that the isdst field may be absent. However, in the std.osdate class definition (line 45), isdst is defined as mandatory (boolean). It should be marked as optional (boolean?) to correctly reflect the behavior of os.date.