MarketSquare / MarketSquare/robotframeworkguides
Variable naming in example documentation is confusing
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 52
- Forks
- 89
- Avg merge
- 9h 13m
- Merged PRs (30d)
- 1
Description
Variable guide does not explain difference between suite and test variables and not between suite and global.
It also seems that my_suite_var and my_test_var in example is mixed some weird way. Maybe it should be my_suite_var every time?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open website/docs/variables.mdx at the referenced section around line 47 and read the surrounding variable examples. Clarify the differences between suite, test, and global variables, then make the example names consistent. Done means the guide explains these scopes plainly and no longer mixes my_suite_var with my_test_var.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100