Skip to content

docs: sync README param names with #18/#19 renames#20

Merged
dimalvovs merged 4 commits intomainfrom
copilot/update-readme-new-param-names
Mar 31, 2026
Merged

docs: sync README param names with #18/#19 renames#20
dimalvovs merged 4 commits intomainfrom
copilot/update-readme-new-param-names

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

README still referenced the pre-#18/19 parameter names (--group, group:) after those PRs renamed them to --groups / groups: (list format). Also aligns the runtime print label in ontrack.py with the documentation.

Changes

  • Config example: group: your_group_namegroups:\n - your_group_name
  • Config key table: groupgroups; description updated to reflect list type and --groups override
  • CLI options table: --group GROUP--groups GROUP [GROUP ...]
  • Operating Modes: command example and prose updated to --groups
  • Example Output: label kept as Group : (describes an individual group value, not the parameter name)
  • ontrack.py: print label changed from Groups : to Group : to match the documented example output

Copilot AI changed the title [WIP] Fix README to reflect new parameter names after changes docs: sync README param names with #18/#19 renames Mar 31, 2026
Copilot AI requested a review from dimalvovs March 31, 2026 13:26
Copy link
Copy Markdown
Contributor

@dimalvovs dimalvovs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think lines 77 and 83 of README do not require changes, as these describe individual groups, not the groups parameter. looks good otherwise.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 31, 2026

I think lines 77 and 83 of README do not require changes, as these describe individual groups, not the groups parameter. looks good otherwise.

Reverted in e1ad133. Note that ontrack.py line 349 currently prints Groups : (changed in PR #18), so the example output is now slightly inconsistent with actual program output — let me know if you'd also like the code's print label adjusted.

Copilot AI requested a review from dimalvovs March 31, 2026 13:43
@dimalvovs dimalvovs marked this pull request as ready for review March 31, 2026 13:43
@dimalvovs
Copy link
Copy Markdown
Contributor

@copilot yes, please do also change the code's print label to match the documentation.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 31, 2026

@copilot yes, please do also change the code's print label to match the documentation.

Done in ea3ed1eontrack.py now prints Group : and the corresponding test assertions and docstrings have been updated to match.

@dimalvovs dimalvovs merged commit f9f6648 into main Mar 31, 2026
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants