Skip to content

Add periods to doc comments in modified files#3134

Draft
Copilot wants to merge 2 commits intoperf/revived_2145from
copilot/sub-pr-3127
Draft

Add periods to doc comments in modified files#3134
Copilot wants to merge 2 commits intoperf/revived_2145from
copilot/sub-pr-3127

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 30, 2026

Addresses review feedback on PR #3127 requesting proper punctuation in documentation comments.

Changes

  • algorithms/src/polycommit/sonic_pc/data_structures.rs: Added periods to doc comments for CommitterKey::update(), field descriptions, and utility methods
  • algorithms/src/snark/varuna/varuna.rs: Added periods to doc comments for batch_circuit_setup(), prove_vk(), and verify_vk()

Example fix:

// Before:
/// Update the committer_key
/// The `powers_of_beta_g` and `shifted_powers_of_beta_g` may grow or shrink

// After:
/// Update the committer_key.
/// The `powers_of_beta_g` and `shifted_powers_of_beta_g` may grow or shrink.

This PR targets the copilot/pr-3127 branch as part of the stacked PR workflow.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: iamalwaysuncomfortable <26438809+iamalwaysuncomfortable@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix doc comments by adding periods as suggested in review feedback Add periods to doc comments in modified files Jan 30, 2026
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