openQA icon indicating copy to clipboard operation
openQA copied to clipboard

Make description of _GROUP_ID more obvious

Open asmorodskyi opened this issue 4 months ago • 4 comments

asmorodskyi avatar Aug 27 '25 16:08 asmorodskyi

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

  • [ ] Consider generating documentation locally to verify it is rendered correctly. See https://open.qa/docs/#_making_documentation_changes

This is an automatically generated QA checklist based on modified files.

github-actions[bot] avatar Aug 27 '25 16:08 github-actions[bot]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 99.22%. Comparing base (92286c8) to head (342aca0). :warning: Report is 336 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6683   +/-   ##
=======================================
  Coverage   99.21%   99.22%           
=======================================
  Files         398      398           
  Lines       40872    40872           
=======================================
+ Hits        40553    40554    +1     
+ Misses        319      318    -1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Aug 27 '25 17:08 codecov[bot]

I like the current descriptions better.

can you elaborate ? it is hard to argue with this statement . My main concern that description of one variable should not force you to read description of another no matter that they are "neighbours" in the text

asmorodskyi avatar Sep 01 '25 13:09 asmorodskyi

My main concern that description of one variable should not force you to read description of another no matter that they are "neighbours" in the text

I disagree. There's no harm in the reference when it just refers to the previous line. When one is reading from top to bottom this way repetition is avoided. When one reads the last variable first they just have to look one line above and then maybe even realize that this is the variable they were actually looking for.

Martchus avatar Sep 02 '25 13:09 Martchus