doc: Map Type

[xushiwei]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @xushiwei, I'm Gemini Code Assist¹! 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 introduces a new documentation file, "doc/map.md", which serves as a comprehensive guide to the "Map Type" in XGo. The document aims to educate users on how to effectively create, manipulate, and utilize maps, covering everything from basic syntax and type inference to advanced operations and best practices. This addition significantly enhances the clarity and accessibility of XGo's core data structures for developers.

Highlights

• New Map Type Documentation: Introduces a comprehensive guide for XGo's map type, detailing its syntax, type inference rules, and various operations.
• Map Operations Explained: Covers essential map operations such as creation, element access, key existence checks, adding/updating, deleting, and iteration methods.
• Best Practices and Patterns: Provides guidance on common map usage patterns and best practices for writing readable and efficient map-related code in XGo.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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. ↩

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.96%. Comparing base (4b62659) to head (d63e513).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2586   +/-   ##
=======================================
  Coverage   93.96%   93.96%           
=======================================
  Files          34       34           
  Lines        9808     9808           
=======================================
  Hits         9216     9216           
  Misses        422      422           
  Partials      170      170           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[gemini-code-assist]

Code Review

This pull request adds documentation for the Map type in XGo. The document is well-structured and covers the basics. I've added a few suggestions to improve clarity, correctness of examples, and completeness by including missing patterns and functions like make.

[xgopilot]

Review Summary

Good documentation for XGo's Map Type! The structure is clear and covers fundamental operations well.

Issues to address:

1. Counting occurrences example won't compile - empty map {} is map[string]any, causing type mismatch with + 1
2. Missing map comprehensions - a core XGo feature documented in docs.md but absent here

Minor suggestions:

• Consider adding non-string key type examples
• The any type could use a brief explanation