-
Notifications
You must be signed in to change notification settings - Fork 48
doc: Revamp Python Packaging #349
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
Conversation
Summary of ChangesHello @junrushao, 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 primarily focuses on enhancing and restructuring the project's documentation. It standardizes external links, reorganizes guide content into a more logical reference structure, and updates the Python packaging guide to reflect current best practices for library loading. Additionally, it includes minor C++ Doxygen syntax fixes and improvements to the Python stub generation tool. Highlights
🧠 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 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 introduces a significant documentation update and refactoring. Key changes include reorganizing the documentation structure, updating links, and improving Doxygen comments in C++ headers for better clarity. The Python packaging guide has been simplified, and several unused headers have been removed from C++ files. Additionally, the Python stub generator is enhanced to filter stubs by prefix, a change that is well-tested. Overall, these are high-quality improvements to the project's documentation and tooling. I have not found any issues of medium or higher severity.
8df5f66 to
dc43d06
Compare
dbf8023 to
ca70fd9
Compare
df9ac08 to
6fa4fbc
Compare
6fa4fbc to
13bb644
Compare
This PR includes change in a few fronts:
New Doc Structure