Skip to content
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.

Sign up for GitHub

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

Jump to bottom

improve(docstrings): Follow up fixes #269

Merged
merged 1 commit into from
Mar 31, 2023
Merged

improve(docstrings): Follow up fixes #269

merged 1 commit into from
Mar 31, 2023

Conversation

nicholaspai
Copy link
Member

  • In Polygon_Adapter.sol, the user parameter for the depositEtherFor function is documented using "@dev" instead of "@param user".
  • In SpokePool.sol, within the RelayExecution struct's relay parameter description, "parametersin" should be "parameters in".
  • In SpokePool.sol, the RelayExecution struct's docstring for parameter payoutAdjustmentPct lists it as "payoutAdjustment".

@nicholaspai
improve(docstrings): Follow up fixes
c912b90 
- In Polygon_Adapter.sol, the user parameter for the depositEtherFor function is documented using "@dev" instead of "@param user".
- In SpokePool.sol, within the RelayExecution struct's relay parameter description, "parametersin" should be "parameters in".
- In SpokePool.sol, the RelayExecution struct's docstring for parameter payoutAdjustmentPct lists it as "payoutAdjustment".
@nicholaspai nicholaspai requested review from mrice32 and pxrl March 30, 2023 16:40
pxrl
pxrl approved these changes Mar 30, 2023
View reviewed changes
Copy link
Contributor

@pxrl pxrl left a comment

Choose a reason for hiding this comment

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

One curiosity.

@nicholaspai nicholaspai requested a review from pxrl March 30, 2023 19:18
pxrl
pxrl approved these changes Mar 30, 2023
View reviewed changes
Copy link
Contributor

@pxrl pxrl left a comment

Choose a reason for hiding this comment

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

All good - sorry for the redundant question!

@nicholaspai nicholaspai merged commit 146f2f2 into master Mar 31, 2023
@nicholaspai nicholaspai deleted the docstrings branch March 31, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pxrl pxrl pxrl approved these changes

@mrice32 mrice32 Awaiting requested review from mrice32 mrice32 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nicholaspai @pxrl