Skip to content

Fix code and comments inconsistency #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

intls
Copy link

@intls intls commented Jan 19, 2025

Motivation

Describe why this issue should be fixed and link to any relevant design docs, issues or other relevant items.

Change Summary

Describe the changes being made in 1-2 concise sentences.

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

Additional Context

If this is a relatively large or complex change, provide more details here that will help reviewers.


PR-Codex overview

This PR focuses on improving the documentation comments in the Solidity interface files by correcting typos and enhancing clarity.

Detailed summary

  • In src/interfaces/IKeyRegistry.sol, the comment for metadata was changed from "Metadata of the signer key." to "Metadata about the signer key."
  • In src/interfaces/IIdGateway.sol, the comment for _storageRegistry was corrected from "StorageREgistry" to "StorageRegistry."

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@intls intls changed the title Fix inconsistency between code and comments Fix code and comments inconsistency Jan 19, 2025
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