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

types with methods should be documented as typescript interfaces #9766

Open
Tracked by #9757
dckc opened this issue Jul 24, 2024 · 0 comments
Open
Tracked by #9757

types with methods should be documented as typescript interfaces #9766

dckc opened this issue Jul 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dckc
Copy link
Member

dckc commented Jul 24, 2024

What is the Problem Being Solved?

LiquidStakingMethods is a type for a Remotable; it's a collection of methods. When declared as a type alias, typedoc doesn't provide links to the individual methods.

contrast with IcaAccount:
image

type aliases work well for data structures, but not for remotable interfaces.

Description of the Design

Security Considerations

Scaling Considerations

Test Plan

Upgrade Considerations

@dckc dckc added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant