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

Use of internal TypedPattern in external APIs is awkward / obscure #9994

Open
Tracked by #9757
dckc opened this issue Aug 29, 2024 · 0 comments
Open
Tracked by #9757

Use of internal TypedPattern in external APIs is awkward / obscure #9994

dckc opened this issue Aug 29, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@dckc
Copy link
Member

dckc commented Aug 29, 2024

Describe the bug

API docs for type guards such as ChainInfoShapeConst make a clear link to ChainInfo, but presume that TypedPattern is self-explanatory. In particular, there is no path to docs for endo patterns.

IOU more. time for a meeting

ref July 24 discussion b78fbfa#r1690222234

To Reproduce

Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior

A clear and concise description of what you expected to happen.

Platform Environment

  • what OS are you using? what version of Node.js?
  • is there anything special/unusual about your platform?
  • what version of the Agoric-SDK are you using? (run git describe --tags --always)

Additional context

Add any other context about the problem here.

Screenshots

If applicable, add screenshots to help explain your problem, especially for UI interactions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant