Variable naming in example documentation is confusing
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
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.
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?
- Dominant language
- MDX
- Stars
- 53
- Forks
- 89
- Avg merge
- 9h 13m
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from MarketSquare/robotframeworkguides
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 1/5 Under an hour Newbie friendliness 50/100
MarketSquare/robotframeworkguides#86 · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Add section about code quality in RFMay be free again @bhirsz claimed this 543 days ago, and no pull request is open. Open
MarketSquare/robotframeworkguides#78 · 1 comment · 1 assignee ·
All issues in MarketSquare/robotframeworkguides
Similar issues
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 4 days
-
area:connector bug
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
tester-army/e2e#1015 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
chroma-core/chroma#7879 ·
Maintainers usually reply within 1 day