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 documentation for Event / Emit #2003

Closed
zivkovicmilos opened this issue Apr 30, 2024 · 1 comment · Fixed by #2047
Closed

[docs] Add documentation for Event / Emit #2003

zivkovicmilos opened this issue Apr 30, 2024 · 1 comment · Fixed by #2047
Assignees
@leohhhn
Labels
📖 documentation Improvements or additions to documentation

Comments

@zivkovicmilos
Copy link
Member

Description

This task concerns adding detailed documentation, usage examples and tutorials for utilizing the newly added event emissions, following #1653.

cc @Kouteki
@zivkovicmilos zivkovicmilos added the 📖 documentation Improvements or additions to documentation label Apr 30, 2024
@zivkovicmilos zivkovicmilos mentioned this issue Apr 30, 2024
Merged
@leohhhn leohhhn moved this to Priority 1 in 👥 Team: Devrels (Outdated) Apr 30, 2024
@leohhhn
Copy link
Contributor

leohhhn commented Apr 30, 2024

I've identified three spots where we should add Event/Emit documentation:

  • stdlibs Concepts & Reference pages
  • Effective Gno, to show examples
  • Gno by Example - to have a practical tutorial on how to use it.

Will work on it ASAP.

@leohhhn leohhhn moved this from Priority 1 to In Progress in 👥 Team: Devrels (Outdated) May 6, 2024
@leohhhn leohhhn mentioned this issue May 6, 2024
Merged
7 tasks
@leohhhn leohhhn moved this from In Progress to In Review in 👥 Team: Devrels (Outdated) May 6, 2024
@leohhhn leohhhn moved this from Triage to In Review in 🧙‍♂️gno.land core team May 9, 2024
leohhhn added a commit that referenced this issue May 13, 2024
@leohhhn @notJoon
feat(docs): emit/event docs (#2047)
977a3f4 
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR adds docs for emit/event. It adds reference docs, and a section
in effective Gno. More practical examples will be added to Gno By
Example.

Closes: #2003 

<details><summary>Contributors' checklist...</summary>

- [ ] Added new tests, or not needed, or not feasible
- [ ] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [ ] Updated the official documentation or not needed
- [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>

---------

Co-authored-by: Lee ByeongJun <[email protected]>
@github-project-automation github-project-automation bot moved this from In Review to Done in 👥 Team: Devrels (Outdated) May 13, 2024
DIGIX666 pushed a commit to kazai777/gno that referenced this issue May 15, 2024
@leohhhn @notJoon
feat(docs): emit/event docs (gnolang#2047)
a612a11 
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR adds docs for emit/event. It adds reference docs, and a section
in effective Gno. More practical examples will be added to Gno By
Example.

Closes: gnolang#2003 

<details><summary>Contributors' checklist...</summary>

- [ ] Added new tests, or not needed, or not feasible
- [ ] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [ ] Updated the official documentation or not needed
- [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>

---------

Co-authored-by: Lee ByeongJun <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leohhhn leohhhn

Labels
📖 documentation Improvements or additions to documentation
Projects
👥 Team: Devrels (Outdated)
Status: Done
🧙‍♂️gno.land core team
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): emit/event docs leohhhn/gno
2 participants
@zivkovicmilos @leohhhn