Remove unnecessary flags from --check test

[koxudaxi]

Summary by CodeRabbit

• Documentation
  • Updated CLI reference documentation by removing references to certain command-line options and related usage examples.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request removes references to deprecated CLI flags (--use-union-operator, --use-standard-collections, and --no-use-standard-collections) from documentation and test files. Documentation examples and related options are simplified, and test expectations are adjusted to reflect these removed flags.

Changes

Cohort / File(s)	Change Summary
Documentation cleanup docs/cli-reference/general-options.md	Removed "Related" option references listing --no-use-standard-collections and --no-use-union-operator; removed union-operator and standard-collections flag usage from --check and other option examples.
Test expectation updates tests/main/test_main_general.py	Removed --disable-timestamp, --use-union-operator, and --use-standard-collections from CLI argument expectations in test_skip_root_model_command_line and test_check_file_matches test cases; adjusted related_options lists accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verification needed: Confirm that the removed flags are indeed deprecated and no longer supported by the CLI.
• Consistency check: Ensure no other documentation files or tests reference these flags elsewhere.
• Test coverage: Verify that the simplified test cases still adequately exercise the intended code paths.

Poem

🐰 Deprecated flags now laid to rest,
Union operators once the best,
Cleaned-up docs, tests refined with care,
Simpler CLI flows everywhere! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Remove unnecessary flags from --check test' accurately describes the main change: removing CLI flags (--disable-timestamp, --use-union-operator, --use-standard-collections) from test expectations and documentation.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/update-person-expected-file

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 66769b1 and 9548ad1.

📒 Files selected for processing (2)

• docs/cli-reference/general-options.md (1 hunks)
• tests/main/test_main_general.py (2 hunks)

🔇 Additional comments (2)

docs/cli-reference/general-options.md (1)

176-176: Unable to verify this review comment due to repository access limitations. Manual verification is required to confirm:

1. The actual content at line 176 of docs/cli-reference/general-options.md
2. Whether the example was simplified by removing --use-union-operator and --use-standard-collections flags
3. Whether person.py expected output files exist in tests/main/expected/ directory
4. Whether the removal of these flags affects the documented output

The review comment's claims about flag simplification and expected output file verification cannot be confirmed without direct access to the repository structure and file contents.

tests/main/test_main_general.py (1)

476-499: Due to network connectivity constraints in the verification environment, I was unable to access the repository to examine the test file, run the test, or verify critical dependencies such as the DATA_PATH configuration, fixture setup, and golden output file existence.

Based on the code snippet provided and web documentation confirming the --check flag behavior, the test logic appears sound: it follows the correct pattern of generating a baseline file and then validating with --check to confirm they match. The documented behavior shows --check exits with code 0 when files are up-to-date, which aligns with the test's expected_exit=Exit.OK assertion.

However, without executing the test or examining the complete test setup (including fixtures, helper functions, and data files), I cannot definitively confirm the review comment is accurate.

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.34%. Comparing base (66769b1) to head (9548ad1).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2708   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files          81       81           
  Lines       11535    11535           
  Branches     1387     1387           
=======================================
  Hits        11459    11459           
  Misses         45       45           
  Partials       31       31           

Flag	Coverage Δ
unittests	99.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[codspeed-hq]

CodSpeed Performance Report

Merging #2708 will not alter performance

_{Comparing fix/update-person-expected-file (9548ad1) with main (66769b1)}

Summary

✅ 52 untouched
⏩ 10 skipped¹

Footnotes

1. 10 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩