cli: pgp export help needs better documentation

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#24,313 0 bình luận 2 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
1/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
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
go
Lĩnh vực
cli, cryptography

Hướng nghiên cứu

Tìm phần triển khai lệnh CLI và văn bản trợ giúp cho keybase pgp export cùng tùy chọn --query của lệnh này. Cập nhật văn bản trợ giúp để giải thích rằng truy vấn khớp với một dấu vân tay PGP, sau đó chạy keybase pgp export --help để kiểm tra cách diễn đạt.

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

Mô tả

I have multiple keys on my account. When I ran keybase pgp export, it errored and said I needed to specify a key to export. I checked the --help docs and saw there was a --query option. However, the syntax of what a query looks like was not explained.

Thanks to https://github.com/keybase/client/issues/6548, I was able to figure it out. But I suggest updating the help text to be clearer. Something like:

--query    Only export keys matching that PGP fingerprint.
  • keybase version 5.5.1-20200527202541+39ca0071e5
Ngôn ngữ chính
Go
Star
9.3k
Fork
1.3k
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
99

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có 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 keybase/client

Tất cả issue của keybase/client

Issue tương tự

Thêm issue về Go

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.