Skip to content

doc: Remove stale notes#204

Merged
tqchen merged 1 commit into
apache:mainfrom
junrushao:2025-10-29/fix-export-doc
Oct 29, 2025
Merged

doc: Remove stale notes#204
tqchen merged 1 commit into
apache:mainfrom
junrushao:2025-10-29/fix-export-doc

Conversation

@junrushao

Copy link
Copy Markdown
Member

There was a note in TVM_FFI_DLL_EXPORT_TYPED_FUNC saying:

\note ExportName and Function must be different

which has been stale for a while. The system doesn't have the constraint as of today. This PR removes this line.

There was a note in `TVM_FFI_DLL_EXPORT_TYPED_FUNC` saying:

```
\note ExportName and Function must be different
```

which has been stale for a while. The system doesn't have the constraint
as of today. This PR removes this line.
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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 focuses on improving the accuracy of the project's documentation by removing outdated information. Specifically, it addresses a note that no longer reflects the current system's behavior, ensuring that developers rely on correct and up-to-date guidance when working with the FFI.

Highlights

  • Documentation Cleanup: Removed a stale note from the TVM_FFI_DLL_EXPORT_TYPED_FUNC documentation in include/tvm/ffi/function.h. The note incorrectly stated that ExportName and Function must be different, a constraint that is no longer valid in the system.
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
Contributor

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 removes a stale documentation note from the TVM_FFI_DLL_EXPORT_TYPED_FUNC macro. The note incorrectly stated that the ExportName and Function parameters must be different. As confirmed by existing test cases, this constraint is no longer valid. The change is correct and improves the accuracy of the documentation. I have no further comments.

@nvmbreughe nvmbreughe 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.

LGTM

@tqchen tqchen merged commit 8bea08e into apache:main Oct 29, 2025
7 checks passed
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.

3 participants