chore(docs): focus AIP-140 numbers link#1604
Conversation
Summary of ChangesHello @noahdietz, 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 refines the documentation by making a specific link more precise. By adding a fragment identifier to the AIP-140 reference, readers will now be directed exactly to the relevant "case" section, improving navigation and clarity within the documentation. Highlights
Changelog
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.
Code Review
This pull request updates a link in the documentation for the 0140/numbers rule. The change aims to make the link to AIP-140 more specific. However, the new link points to the #case section, which is about snake_case, while the rule itself is about not using numbers at the beginning of words in field names. I've suggested reverting this change as the original link to the top of the AIP-140 page is more appropriate, given there's no specific anchor for the 'Numbers' section.
| top of the file. | ||
|
|
||
| [aip-140]: https://aip.dev/140 | ||
| [aip-140]: https://aip.dev/140#case |
There was a problem hiding this comment.
The link to AIP-140 now points to the #case anchor. This rule (0140/numbers) is about not starting words in field names with numbers, which corresponds to the 'Numbers' section of AIP-140. The #case anchor points to the section about using snake_case. Since the 'Numbers' section does not have a specific anchor on the AIP-140 page, linking to the top of the page is more appropriate as it allows users to find the relevant section easily. The previous link was more accurate.
| [aip-140]: https://aip.dev/140#case | |
| [aip-140]: https://aip.dev/140 |
No description provided.