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

[Docs]: Lack of information about std.Test functions #2817

Open
MalekLahbib opened this issue Sep 19, 2024 · 1 comment
Open

[Docs]: Lack of information about std.Test functions #2817

MalekLahbib opened this issue Sep 19, 2024 · 1 comment
Labels
hacktoberfest This might be a good issue for a hacktoberfest participant to handle.

Comments

@MalekLahbib
Copy link
Contributor

Description

I tried to create a test file for a realm where I needed to send coins. I had to search the docs and the examples to figure out how to do it, and it's still not very clear for me:

  • how to use the functions ?
  • what every function do?
  • what functions are needed and in what order?

The docs doesn't clarify this points and there's no link to an example where everything is explained. After a discussion yesterday with @moul, I opened this issue and wanted to know if I can work on example that can simplify and clarify the usage of this functions for a newcomer (I may need help to understand how this functions work exactly :) ).
@leohhhn @michelleellen @zivkovicmilos @thehowl

@thehowl
Copy link
Member

thehowl commented Sep 19, 2024

More examples are always welcome. You can do that as a starting explainer. Though, if you read some of the source and can make sense of it, I suggest you also try writing some "actual documentation".

After your example, if you want to tackle this issue properly, I suggest you two PRs:

  1. Make a PR adding godoc comments to the functions in gnovm/tests/stdlibs. This way, they can eventually show up in the gno doc output.
  2. Move these functions to the normal standard libraries (gnovm/stdlibs); but disable them entirely when not testing.

There is a PR that starts part of this work, but it'll be a while until I'm able to finish its vision: #2425

In the meantime, this is a good starting approach, as it allows us to have gno doc documentation for these functions, from the command line. If you want, you can also take up on the efforts to have this documentation on the web; see #522 and #526.

@leohhhn leohhhn changed the title lack of informations about std testing functions [Docs]: Lack of information about std.Test functions Sep 23, 2024
@wyhaines wyhaines added the hacktoberfest This might be a good issue for a hacktoberfest participant to handle. label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest This might be a good issue for a hacktoberfest participant to handle.
Projects
Status: Triage
Development

No branches or pull requests

3 participants