Skip to content

Conversation

zyfy29
Copy link
Contributor

@zyfy29 zyfy29 commented Aug 20, 2025

I mentioned it in the #3666 but forgot to do in the former pr. I think it's better to notify the rule here as well.

@Copilot Copilot AI review requested due to automatic review settings August 20, 2025 06:50
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the CONTRIBUTING.md documentation to clarify that documentation requirements apply to both exported methods and types, not just methods. It adds an example showing how to properly document exported types following Go documentation conventions.

  • Expands documentation requirements from "exported methods" to "exported methods and types"
  • Adds a concrete example demonstrating proper type documentation format

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

...
}
```
And the returned type `Repository` will have comments like this:
Copy link
Preview

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

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

The phrase 'returned type' is misleading since Repository may not necessarily be a return type in all contexts. Consider using 'exported type' instead to be more accurate and consistent with the updated guideline.

Suggested change
And the returned type `Repository` will have comments like this:
And the exported type `Repository` will have comments like this:

Copilot uses AI. Check for mistakes.

Copy link

codecov bot commented Sep 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.12%. Comparing base (3646f33) to head (5b468ff).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3693   +/-   ##
=======================================
  Coverage   91.12%   91.12%           
=======================================
  Files         187      187           
  Lines       16640    16640           
=======================================
  Hits        15164    15164           
  Misses       1291     1291           
  Partials      185      185           

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

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

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

Thank you, @zyfy29!
LGTM.
Merging.

@gmlewis gmlewis merged commit 52048c2 into google:master Sep 22, 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.

2 participants