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

add Events docs file = docs/src/pages/docs/events.md #2008

Closed
wants to merge 11 commits into from

Conversation

ashpoolin
Copy link

  1. Create new section of docs for Events (path: docs/src/pages/docs/events.md).

  2. Update docs/src/pages/_app.jsx to include Events in table of contents.

@vercel
Copy link

vercel bot commented Jun 27, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
anchor-docs ✅ Ready (Inspect) Visit Preview Jun 27, 2022 at 8:10PM (UTC)

Copy link
Contributor

@nhein-tt nhein-tt left a comment

Choose a reason for hiding this comment

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

Hey, thanks for putting this together! I did a pass over it, LMK what you think of any of my comments/concerns.

docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
docs/src/pages/docs/events.md Show resolved Hide resolved
docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
Comment on lines +60 to +61
Note that the event is declared with the `#[event]` macro, and defined using a `struct`. To supply the values,
the pattern `emit!(MyEvent {...});` is used. The code above is a basic stamp that can be used for creating and consuming events within your program.
Copy link
Contributor

Choose a reason for hiding this comment

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

could you speak to the #[index] in the event?
I'm relatively new to Anchor, so I could easily be missing something here. But I think if I'm confused, another reader could be as well.

Copy link
Author

Choose a reason for hiding this comment

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

I honestly don't know what that macro does. I googled it and came up empty-handed. Maybe someone can make a suggestion here, if they think it's very important.

Copy link
Contributor

Choose a reason for hiding this comment

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

looks like index will add metadata to the IDL

for off chain indexers

docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
docs/src/pages/docs/events.md Outdated Show resolved Hide resolved
@nhein-tt
Copy link
Contributor

nhein-tt commented Jul 5, 2022

perhaps related to: #1110 although that issue is dated, there is events on @paul-schaaf 's todolist.

@ashpoolin
Copy link
Author

Hi @nheingit, thanks for the input! Generally, agree with all of your suggestions, and it's fine if you want to change them yourself. I'm traveling tomorrow, but will review more closely when I'm back to my desk.

@vercel
Copy link

vercel bot commented Jul 9, 2022

@ashpoolin is attempting to deploy a commit to the 200ms Team on Vercel.

A member of the Team first needs to authorize it.

@italoacasas
Copy link
Contributor

@ashpoolin, can you check the page title? Something seems off

Screen Shot 2022-08-11 at 4 36 52 PM

@ashpoolin
Copy link
Author

@ashpoolin, can you check the page title? Something seems off

Screen Shot 2022-08-11 at 4 36 52 PM

@italoacasas sorry for the very slow response--I hadn't checked here in awhile. Are you sure there's an issue? I couldn't reproduce, but also I think that I've addressed it:
image

Let me know. Thanks!

@armaniferrante
Copy link
Member

Closing as stale.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants