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

How do you check that programs in the README work? #3224

Closed
deemp opened this issue Jun 10, 2024 · 2 comments
Closed

How do you check that programs in the README work? #3224

deemp opened this issue Jun 10, 2024 · 2 comments

Comments

@deemp
Copy link
Member

deemp commented Jun 10, 2024

EO versions change, so demo programs in README may become invalid. How do you check that programs are always valid?

In particular, I'm interested in the multiplication table example.

eo/README.md

Lines 150 to 168 in c5bbe04

[args...] > app
memory 0 > x
seq > @
*
x.write 2
while.
x.lt 6
[i]
seq > @
*
QQ.io.stdout
QQ.txt.sprintf
"%d x %d = %d\n"
x
x
x.times x
x.write
x.plus 1
true

In the normalizer repo, I use mdsh to check that commands indeed work and to update their input (link).

Copy link

@deemp thanks for the report, here is a feedback:

Problems

  • The bug report does not provide a clear and succinct problem statement, appearing more as a query than a bug.
  • There is a lack of specific error messages or descriptions detailing the 'invalid' behavior reported.
  • The bug report does not adhere to a standard format - missing steps to reproduce the issue, along with expected and actual results.

I would recommend: "Provide steps to reproduce, expected and actual results in a standard bug report format."

Please fix the bug report in order it to get resolved faster.
Analyzed with gpt-4

@yegor256
Copy link
Member

@deemp it's a duplicate of #3134

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

No branches or pull requests

2 participants