Skip to content

Conversation

wlxjhyf
Copy link
Collaborator

@wlxjhyf wlxjhyf commented Oct 16, 2025

PR Category

Docs

Type of Change

Documentation Fix

Description

remove extra 'D' from FLAGGEMS_USE_EXTERNAL_TRITON_JIT in CMAKE_ARGS

Issue

Progress

  • Change is properly reviewed (1 reviewer required, 2 recommended).
  • Change is responded to an issue.
  • Change is fully covered by a UT.

Performance

Copy link
Contributor

Summary of Changes

Hello @wlxjhyf, 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 addresses a minor but critical documentation error in the installation guide. By fixing a typo in a CMake argument, it ensures that users can accurately follow the instructions for building with external TritonJIT, preventing potential configuration issues during the installation process.

Highlights

  • Documentation Fix: Corrected a typo in the CMAKE_ARGS environment variable within the docs/installation.md file, specifically removing an extra 'D' from DDFLAGGEMS_USE_EXTERNAL_TRITON_JIT to DFLAGGEMS_USE_EXTERNAL_TRITON_JIT.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 correctly fixes a typo in the CMAKE_ARGS example within the installation documentation. By removing an extra 'D' from the -DFLAGGEMS_USE_EXTERNAL_TRITON_JIT flag, you've prevented a potential source of error for users trying to build the project from source. The change is accurate and improves the quality of the documentation. I have one minor suggestion to address a similar inconsistency in the same file to further enhance clarity.

pip install -U scikit-build-core ninja cmake pybind11

CMAKE_ARGS="-DFLAGGEMS_BUILD_C_EXTENSIONS=ON -DDFLAGGEMS_USE_EXTERNAL_TRITON_JIT=ON -DTritonJIT_ROOT=<install path of triton-jit>" \
CMAKE_ARGS="-DFLAGGEMS_BUILD_C_EXTENSIONS=ON -DFLAGGEMS_USE_EXTERNAL_TRITON_JIT=ON -DTritonJIT_ROOT=<install path of triton-jit>" \
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Thank you for correcting the typo for the FLAGGEMS_USE_EXTERNAL_TRITON_JIT flag. While reviewing this line, I noticed a related inconsistency within this document that could confuse users. You are correctly using the plural form FLAGGEMS_BUILD_C_EXTENSIONS here, which aligns with its definition in CMakeLists.txt. However, the description on line 50 refers to it using the singular form, FLAGGEMS_BUILD_C_EXTENSION. To maintain consistency and prevent potential user errors, I recommend updating the variable on line 50 to its plural form as well.

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.

1 participant