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: use doc strings from the abi in abigen #1390

Merged
merged 3 commits into from
May 27, 2024
Merged

feat: use doc strings from the abi in abigen #1390

merged 3 commits into from
May 27, 2024

Conversation

hal3e
Copy link
Contributor

@hal3e hal3e commented May 24, 2024

closes: #1335

Adds ABI doc strings to contract methods and script's main function.

Checklist

  • I have linked to any relevant issues.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary labels.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@hal3e hal3e added the tech-debt Improves code quality or safety label May 24, 2024
@hal3e hal3e self-assigned this May 24, 2024
@hal3e hal3e changed the title feat: use doc strings from abi in abigen feat: use doc strings from the abi in abigen May 24, 2024
segfault-magnet
segfault-magnet reviewed May 27, 2024
View reviewed changes
Copy link
Contributor

@segfault-magnet segfault-magnet left a comment

Choose a reason for hiding this comment

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

Cool.

Fine with the impl, just waiting for the release of fuel abi types.

Cargo.toml Outdated Show resolved Hide resolved
Br1ght0ne
Br1ght0ne previously approved these changes May 27, 2024
View reviewed changes
Copy link
Member

@Br1ght0ne Br1ght0ne left a comment

Choose a reason for hiding this comment

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

LGTM, and I agree with @segfault-magnet on releasing

@hal3e hal3e merged commit 068543c into master May 27, 2024
44 checks passed
@hal3e hal3e deleted the hal3e/docstrings-contract-methods branch May 27, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Br1ght0ne Br1ght0ne Br1ght0ne approved these changes

@Salka1988 Salka1988 Salka1988 approved these changes

@segfault-magnet segfault-magnet segfault-magnet approved these changes

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

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

Assignees

@hal3e hal3e

Labels
tech-debt Improves code quality or safety
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generate doc strings for functions from JSON ABI
4 participants
@hal3e @Br1ght0ne @Salka1988 @segfault-magnet