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

docs: add ambiguity details to Encodable rustdoc #211

Merged
merged 4 commits into from
Jul 28, 2023
Merged

docs: add ambiguity details to Encodable rustdoc #211

merged 4 commits into from
Jul 28, 2023

Conversation

prestwich
Copy link
Member

@prestwich prestwich commented Jul 28, 2023 •
edited
Loading

Motivation

Conversation in telegram

Solution

  • Adds ambiguity details and recommendations to the Encodable<T: SolType> trait docs
  • Adds a sol_type_name passthrough function to Encodable<T: SolType> for convenience wrt unambiguous types

PR Checklist

  • Added Tests
  • Added Documentation
  • [no] Breaking changes

@prestwich prestwich added the enhancement New feature or request label Jul 28, 2023
@prestwich prestwich self-assigned this Jul 28, 2023
@prestwich prestwich marked this pull request as ready for review July 28, 2023 16:04
DaniPopes
DaniPopes approved these changes Jul 28, 2023
View reviewed changes
Copy link
Member

@DaniPopes DaniPopes left a comment

Choose a reason for hiding this comment

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

LGTM. Nits

crates/sol-types/src/types/ty.rs Outdated Show resolved Hide resolved
crates/sol-types/src/types/ty.rs Outdated Show resolved Hide resolved
crates/sol-types/src/types/ty.rs Outdated Show resolved Hide resolved
crates/sol-types/src/types/ty.rs Outdated Show resolved Hide resolved
crates/sol-types/src/types/ty.rs Outdated Show resolved Hide resolved
@prestwich prestwich merged commit 54e852e into main Jul 28, 2023
@DaniPopes DaniPopes deleted the prestwich/encodable-doc branch July 28, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DaniPopes DaniPopes DaniPopes approved these changes

Assignees

@prestwich prestwich

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@prestwich @DaniPopes