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.

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

Corrects comment. #147

Closed
wants to merge 1 commit into from
Closed

Conversation

MicahZoltu
Copy link

Fix a bug

Bug Report

N/A

Implementation

Fixes error in NatSpec comment.

Additional Context

It is unclear what Avatar is for as it isn't used anywhere in this file or other files I looked at. The comment also doesn't make eit clear how exactly it works.

Copy link

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request

@MicahZoltu
Copy link
Author

MicahZoltu commented Dec 10, 2023

I don't have the time nor inclination to read the CLA document just to fix a typo. Feel free to close this PR if you like and consider this change CC0 so someone else can apply it without fear/worry of me getting upset that they fixed the typo without my permission. 🙄

@auryn-macmillan
Copy link
Member

Thanks @MicahZoltu. I believe the original comment was more correct, since the encoded call should ultimately be executed by the avatar. In most cases, target and avatar are the same, but it cases where mods are chained together, target is the next step in the chain that ultimately leads to avatar.

Nonetheless, reviewing this made me realized that the NatSpec comments use @notice and @dev the wrong way around. Will make a separate PR to address this.

@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants