-
-
Notifications
You must be signed in to change notification settings - Fork 139
replace $(projectdir) by os.projectdir() #258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
@charlesseizilles is attempting to deploy a commit to the waruqi's projects Team on Vercel. A member of the Team first needs to authorize it. |
❌ Deploy Preview for mellow-creponne-9cce3d failed.
|
Summary of ChangesHello @charlesseizilles, 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 enhancing the clarity and consistency of documentation examples. It updates specific code snippets in the API documentation to use the Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 updates the documentation to use os.projectdir() instead of $(projectdir), which is a good improvement. I've suggested using path.join for better cross-platform path construction. Additionally, it seems this change has not been applied to all relevant documentation files. For instance, the Chinese version of this document (docs/zh/api/description/global-interfaces.md) and other examples in docs/api/scripts/builtin-modules/os.md still use the old $(projectdir) syntax. It would be great to update them as well for consistency.
|
|
||
| ```lua | ||
| add_moduledirs("$(projectdir)/modules") | ||
| add_moduledirs(os.projectdir() .. "/modules") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better cross-platform compatibility and code clarity when constructing paths, it's recommended to use path.join() instead of string concatenation. This ensures that the correct path separator is used regardless of the operating system.
| add_moduledirs(os.projectdir() .. "/modules") | |
| add_moduledirs(path.join(os.projectdir(), "modules")) |
|
|
||
| ```lua | ||
| add_plugindirs("$(projectdir)/plugins") | ||
| add_plugindirs(os.projectdir() .. "/plugins") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better cross-platform compatibility and code clarity when constructing paths, it's recommended to use path.join() instead of string concatenation. This ensures that the correct path separator is used regardless of the operating system.
| add_plugindirs(os.projectdir() .. "/plugins") | |
| add_plugindirs(path.join(os.projectdir(), "plugins")) |
No description provided.