[Doc Drift] README extract flags table missing `--remove-stale`

Đang mở Phù hợp với người mới
#250 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
94/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu với bảng các flag của apiops extract trong README.md, sau đó đối chiếu với docs/commands/extract.md ở dòng 69 và đầu ra của apiops extract --help được đề cập trong issue. Được xem là hoàn tất khi bảng trong README bao gồm --remove-stale với cách diễn đạt nhất quán với hành vi được tài liệu hóa.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

type:documentation
What drifted

The apiops extract flags table in README.md is missing the --remove-stale flag. The flag exists in the CLI (confirmed by apiops extract --help) and is documented in docs/commands/extract.md, but was not added to the README summary table when it was introduced in commit 570ca00 ("fix: reconcile stale extraction artifacts safely").

Source of truth

apiops extract --help output:

--remove-stale    Remove stale managed artifacts in the selected scope

docs/commands/extract.md line 69:

| `--remove-stale` | boolean | false | No | Remove stale managed artifacts in the selected filter and workspace scope after a fully successful extraction |
Affected documentation
  • README.md — the ### \apiops extract`section's flags table (currently lists only--resource-group, --service-name, --output, --filter, --no-transitive`)
Suggested update

Add a row for --remove-stale to the README extract flags table:

| --remove-stale | | Remove stale managed artifacts after a fully successful extraction |

Generated by Documentation Freshness Check — System Policy · 38.1 AIC · ⌖ 6.97 AIC · ⊞ 6.2K · ◷

Ngôn ngữ chính
TypeScript
Star
29
Fork
10
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
22

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/apiops-cli

Tất cả issue của Azure/apiops-cli

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.