Skip to content

Add documentation for rfl::Commented feature#600

Merged
liuzicheng1987 merged 2 commits intof/commentsfrom
add-commented-docs-15519898346803255693
Feb 7, 2026
Merged

Add documentation for rfl::Commented feature#600
liuzicheng1987 merged 2 commits intof/commentsfrom
add-commented-docs-15519898346803255693

Conversation

@liuzicheng1987
Copy link
Contributor

This PR adds documentation for the new rfl::Commented feature.
It includes:

  • A new documentation page docs/commented.md explaining how to use rfl::Commented with YAML and XML, including code examples and API details.
  • Integration of the new page into the MkDocs navigation.
  • An entry in the README.md feature list.

PR created automatically by Jules for task 15519898346803255693 started by @liuzicheng1987

- Created docs/commented.md with examples for YAML and XML.
- Updated mkdocs.yaml to include rfl::Commented in the navigation.
- Added rfl::Commented to the feature overview in README.md.

Co-authored-by: liuzicheng1987 <19538706+liuzicheng1987@users.noreply.github.com>
@google-labs-jules
Copy link

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@gemini-code-assist
Copy link

Summary of Changes

Hello @liuzicheng1987, 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 project's documentation by introducing comprehensive details for the rfl::Commented feature. The changes ensure that users have clear guidance on how to leverage this wrapper for adding comments to fields in supported serialization formats, thereby enhancing the usability and understanding of the rfl library.

Highlights

  • New Feature Documentation: A dedicated documentation page (docs/commented.md) has been added to explain the rfl::Commented wrapper, detailing its usage with YAML and XML, including code examples and API specifics.
  • Documentation Navigation: The newly created commented.md page has been integrated into the MkDocs navigation structure, making it discoverable within the project's documentation.
  • Feature List Update: The README.md file has been updated to include rfl::Commented in the list of supported custom containers, enhancing visibility of this feature.
Changelog
  • README.md
    • Added rfl::Commented to the list of custom containers supported by the library.
  • docs/commented.md
    • New file created to document the rfl::Commented<T> wrapper.
    • Includes explanations and code examples for using rfl::Commented with YAML and XML.
    • Details the API for accessing and modifying the underlying value and comments.
  • mkdocs.yaml
    • Added an entry for rfl::Commented (commented.md) to the documentation navigation menu.
Activity
  • The pull request was automatically generated by Jules to address a task initiated by @liuzicheng1987.
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

@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 adds documentation for the rfl::Commented feature. The changes include a new documentation page, an update to the README, and an update to the MkDocs navigation. The new documentation is clear and well-structured. I've provided a couple of suggestions to further improve the examples in the new commented.md file for better clarity and consistency.

- Created docs/commented.md with examples for YAML and XML.
- Highlighted that comments are write-only and ignored during deserialization.
- Updated mkdocs.yaml to include rfl::Commented in the navigation.
- Added rfl::Commented to the feature overview in README.md.

Co-authored-by: liuzicheng1987 <19538706+liuzicheng1987@users.noreply.github.com>
@liuzicheng1987 liuzicheng1987 merged commit ef33360 into f/comments Feb 7, 2026
312 of 318 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.

1 participant