Skip to content

neighbour: Refer to the correct set of constants for neighbour cache entry type#233

Open
rinehart-eric wants to merge 1 commit into
rust-netlink:mainfrom
rinehart-eric:typo
Open

neighbour: Refer to the correct set of constants for neighbour cache entry type#233
rinehart-eric wants to merge 1 commit into
rust-netlink:mainfrom
rinehart-eric:typo

Conversation

@rinehart-eric

Copy link
Copy Markdown

The doc comment for NeighbourHeader::kind refers to the NDA_* constants whereas the relevant set of constants is RTN_* (see e.g. here).

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @rinehart-eric, 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 rectifies an inaccuracy in the documentation for the NeighbourHeader::kind field. The change updates the associated doc comment to correctly reference the RTN_* constants, which are the appropriate set of definitions for neighbour cache entry types, thereby improving the clarity and correctness of the API documentation.

Highlights

  • Documentation Correction: The doc comment for the kind field within the NeighbourHeader struct was updated to correctly refer to the RTN_* constants, rather than the previously incorrect NDA_* constants, ensuring accurate guidance for neighbour cache entry types.
Changelog
  • src/neighbour/header.rs
    • Corrected the constant reference in the doc comment for the kind field.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
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 gemini-code-assist Bot left a comment

Copy link
Copy Markdown

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 correctly updates a documentation comment for NeighbourHeader::kind. The comment previously referred to the incorrect NDA_* constants, and this change updates it to refer to the correct RTN_* constants. This is an important fix for documentation accuracy, preventing potential misuse of the API. The change is correct and well-contained.

@cathay4t cathay4t left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This property is not constant integer anymore. User don't need to know search C header for RTA_XXX constant anymore, instead, user should use rust native data type.

Please change it to

Neighbour cache entry type: [RouteType]

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.

2 participants