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

✨ feat: Improve documentation for ERC-4626 interface #12871

Merged
merged 3 commits into from
May 18, 2024
Merged

✨ feat: Improve documentation for ERC-4626 interface #12871

merged 3 commits into from
May 18, 2024

Conversation

raxhvl
Copy link
Contributor

@raxhvl raxhvl commented Apr 30, 2024 •
edited by coderabbitai bot

Description

  • Adds name return variable as defined in the specs
  • A glanceable visual map of the interface that highlights:
    • Functions that MUST revert.
    • Functions that MUST include fees.
    • Functions that MUST NOT include fees.
    • Functions that MUST round down.
    • Functions that MUST emit events.

Related Issue

closes #12870

Summary by CodeRabbit

  • Documentation
    • Updated the ERC-4626 standards documentation to include more descriptive return values for functions handling assets, enhancing clarity and user understanding.

@github-actions github-actions bot added the content 🖋️ This involves copy additions or edits label Apr 30, 2024
@netlify Netlify
Copy link

netlify bot commented Apr 30, 2024 •
edited

✅ Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit ba6206d
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/663e13cc62e01b000806a101
😎 Deploy Preview https://deploy-preview-12871--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 7 paths audited
Performance: 49 (🔴 down 7 from production)
Accessibility: 92 (no change from production)
Best Practices: 95 (🔴 down 3 from production)
SEO: 95 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@raxhvl raxhvl changed the title ✨ feat: Improve documentation ERC-4626 interface ✨ feat: Improve documentation for ERC-4626 interface Apr 30, 2024
@raxhvl
Copy link
Contributor Author

raxhvl commented May 3, 2024

@coderabbitai review

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 3, 2024 •
edited

Walkthrough

The recent modifications to the ERC-4626 documentation involve renaming return variables in various view functions to enhance clarity. These changes make the function outputs more descriptive, aiding developers in better understanding the interface's workings.

Changes

File Path Change Summary
.../docs/standards/tokens/erc-4626/index.md Renamed return variables in functions such as asset, maxDeposit, and others for clearer names.

Assessment against linked issues

Objective Addressed Explanation
Improve documentation ERC-4626 interface (#12870) ✅
Return variable names for view functions (#12870) ✅
A visual map of the interface (#12870) ❌ The changes do not include the addition of a visual map as described in the issue objectives.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nloureiro
Copy link
Contributor

@raxhvl, thank you for your contribution!

I made a version more aligned with the overall style of the map image.

What do you think?

map-of-erc-4626

If everything is ok with the image, can you make the change on the PR?

@raxhvl
Copy link
Contributor Author

raxhvl commented May 7, 2024

@nloureiro I love it!. A small fix: convertToShares and convertToAssets must be marked MUST round down towards 0 and NOT MUST NOT revert.

When you are done making the change, I will add that to the PR.

Thank you for making this look good, oh design whisperer!

@wackerow
Copy link
Member

wackerow commented May 7, 2024

Great! @nloureiro assigning to you for design review, @ me when ready and I can do a final sweep

@wackerow wackerow added design All the issues related to design should use this tag needs design approval 🧑‍🎨 Approval from a designer is needed before merging labels May 7, 2024
@nloureiro
Copy link
Contributor

@nloureiro I love it!. A small fix: convertToShares and convertToAssets must be marked MUST round down towards 0 and NOT MUST NOT revert.

When you are done making the change, I will add that to the PR.

Thank you for making this look good, oh design whisperer!

oh, yes, my bad... should be good now

map-of-erc-4626

@raxhvl
Copy link
Contributor Author

raxhvl commented May 8, 2024

@nloureiro @wackerow All clear!

@nloureiro
Copy link
Contributor

@raxhvl sorry... I saw it on a good display and realized I should have exported 2x the size.

Can you stitch with this one? 🙌
map-of-erc-4626

@raxhvl
Copy link
Contributor Author

raxhvl commented May 10, 2024

@nloureiro. Done! Quick heads up the resolution has increased but the image size is actually smaller 70 kb vs 77kb from earlier.

@nloureiro
Copy link
Contributor

@nloureiro. Done! Quick heads up the resolution has increased but the image size is actually smaller 70 kb vs 77kb from earlier.

yes, no worries. 77kb is still a pretty small size for this.

all is good on my end.

thank you for your contribution.

@corwintines corwintines self-assigned this May 18, 2024
corwintines
corwintines approved these changes May 18, 2024
View reviewed changes
Copy link
Member

@corwintines corwintines left a comment

Choose a reason for hiding this comment

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

Nice, LGTM! Thanks @nloureiro and @raxhvl!

@corwintines
Copy link
Member

@all-contributors can you add @raxhvl for content

@allcontributors allcontributors bot mentioned this pull request May 18, 2024
Merged
@allcontributors AllContributors
Copy link
Contributor

@corwintines

I've put up a pull request to add @raxhvl! 🎉

@corwintines corwintines merged commit a57b80a into ethereum:dev May 18, 2024
6 checks passed
@gitpoap-bot gitpoap-bot
Copy link

gitpoap-bot bot commented May 18, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

Be sure to join the Ethereum.org discord if you are interested in contributing further to the project or have any questions for the team.

GitPOAP: 2024 Ethereum.org Contributor:

GitPOAP: 2024 Ethereum.org Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

This was referenced May 22, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nloureiro nloureiro nloureiro approved these changes

@corwintines corwintines corwintines approved these changes

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

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

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

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

Assignees

@nloureiro nloureiro

@corwintines corwintines

Labels
content 🖋️ This involves copy additions or edits design All the issues related to design should use this tag needs design approval 🧑‍🎨 Approval from a designer is needed before merging
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

✨ feat: Improve documention ERC-4626 interface
4 participants
@raxhvl @nloureiro @wackerow @corwintines