matz ยท GitHub

@matz

This commit corrects the placement of C-style block comments
for MRB_API functions in src/variable.c. Comments are now
placed directly before each function definition as per standard
documentation practices.

@matz

gemini-code-assist[bot]

Hello @matz, 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!

Summary of Changes

Hello! gemini-code-assist here to provide a summary of this pull request. This PR, authored by matz, addresses a documentation style issue in src/variable.c. The commit corrects the placement of existing C-style block comments for several MRB_API functions. Previously, some comments were placed after the function signature; this change moves them to the standard location directly before each function definition, improving adherence to documentation practices and code readability.

Highlights

  • Documentation Style Fix: The primary change is the correction of comment placement for MRB_API functions in src/variable.c. Existing C-style block comments are moved to precede the function definitions.
  • Improved Readability: By placing documentation comments consistently before the functions they describe, the code becomes easier to read and understand for developers.

Changelog

Click here to see the changelog
  • src/variable.c
    • Corrected comment placement for mrb_obj_iv_get.
    • Corrected comment placement for mrb_iv_get.
    • Corrected comment placement for mrb_obj_iv_set.
    • Corrected comment placement for mrb_iv_foreach.
    • Corrected comment placement for mrb_iv_set.
    • Corrected comment placement for mrb_obj_iv_defined.
    • Corrected comment placement for mrb_iv_defined.
    • Corrected comment placement for mrb_iv_name_sym_p.
    • Corrected comment placement for mrb_iv_name_sym_check.
    • Corrected comment placement for mrb_iv_copy.
    • Corrected comment placement for mrb_iv_remove.
    • Corrected comment placement for mrb_cv_get.
    • Corrected comment placement for mrb_mod_cv_set.
    • Corrected comment placement for mrb_cv_set.
    • Corrected comment placement for mrb_cv_defined.
    • Corrected comment placement for mrb_const_get.
    • Corrected comment placement for mrb_const_set.
    • Corrected comment placement for mrb_const_remove.
    • Corrected comment placement for mrb_define_const_id.
    • Corrected comment placement for mrb_define_const.
    • Corrected comment placement for mrb_define_global_const.
    • Corrected comment placement for mrb_gv_get.
    • Corrected comment placement for mrb_gv_set.
    • Corrected comment placement for mrb_gv_remove.
    • Corrected comment placement for mrb_const_defined.
    • Corrected comment placement for mrb_const_defined_at.
    • Corrected comment placement for mrb_attr_get.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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[bot]

@matz

matz deleted the fix-comments-variable-c branch

June 5, 2025 23:16

Read the original on github.com โ†—