robotframework / robotframework/robotframework.github.com

Nitpick: wrong comments in the Getting Started "FOR Loops" example

Open
#257 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
83
Forks
85
PR merge metrics
No merged PRs in 30d

Description

It is a very minor issue. I would have fixed it myself, but I don't understand Vue enough to find how.
On the homepage, the Getting Started section features a live editor to play with some examples. One of them is about FOR Loops.
In it, the file 1_in.robot contains :

@{mammals}    cat    dog    cow

[...]

Loop over list
    Log To Console    Four mammals:
    FOR   ${var}    IN    @{mammals}
        Log To Console    ${var}
    END

But there is only 3 mammals, not 4.
The same goes for the birds.
But there is actually 4 users.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the homepage Getting Started live editor and inspect the FOR Loops example in 1_in.robot. Check the listed mammals, birds, and users against their descriptive comments, then update the incorrect counts and verify the rendered example.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.