Usage help: "Inherited options" heading might be confusing in some contexts

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#239 1 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
62/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
cli, clojure
Lĩnh vực
cli

Hướng nghiên cứu

Payload không nêu tên tệp hiển thị văn bản sử dụng, vì vậy hãy bắt đầu bằng cách tìm trong kho mã chuỗi "Inherited options" trong mã đầu ra trợ giúp. Kiểm tra cách tiêu đề được chọn, và liệu một trường hợp chỉ dành cho gốc có thể hiển thị "Global options" trong khi các lệnh lồng nhau giữ nguyên cách diễn đạt hiện tại hay không. Hoàn thành khi đầu ra trợ giúp chỉ ở gốc hiển thị tiêu đề mới và các kiểm thử đầu ra trợ giúp hiện có được cập nhật cho khớp. Hãy xác nhận với maintainer trước, vì issue hỏi liệu thay đổi có hợp lý hay không.

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

Mô tả

Issue

The "Inherited options" heading in usage text is technically correct.
It describes the way bb cli shares options downward in the command tree.
But maybe we can avoid exposing this complex concept to innocent cli users for simpler scenarios.

Scenario

Take the common case where we only have inherited options from the root.
An example usage help from bbin:

$ bbin install --help
Version: 0.2.5

Usage: bbin install [options] <source>

Install a script

Arguments:
  <source>  URL/file/project to install

Options:
      --as           Executable name to give installed script
      --git/url      Git URL of project (by default, inferred from project)
      --git/sha      Git sha for --git/url
      --git/tag      Git tag for --git/url
      --latest-sha   Use latest sha for --git/url
      --mvn/version  Maven version for project
      --local/root   Local directory for project
  -T, --tool         Install script using tool mode
      --ns-default   :ns-default to be used for the installed script for --tool mode only
      --main-opts    Edn for :main-opts to use for the installed script
      --dry-run      Give a data view of what will happen without installing
      --edn          Emit output in edn format

Inherited options:
  --color  Use color/styling in output (--no-color to disable)
  --plain  Use plain output (no color, no table decorations)

Run "bbin --help" for global options.

See https://github.com/babashka/bbin README for example usages.

I think a user would be better served by a heading of "Global options:" for this scenario.

Whatcha think?

Does this make sense?

Ngôn ngữ chính
Clojure
Star
295
Fork
22
Merge trung bình
1 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 babashka/cli

Tất cả issue của babashka/cli

Issue tương tự

Thêm issue về Clojure

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.