Docs don't mention when a class method is considered private v.s public / --help behavior is confusing

Đang mở
#531 2 bình luận 1 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
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu với MWE Python Fire trong issue và so sánh hành vi không có đối số, với --help và với --verbose được mô tả ở đó. Cập nhật tài liệu liên quan để giải thích khi nào các phương thức của class được expose ở dạng public hoặc private và tại sao các lời gọi trợ giúp này lại khác nhau. Hoàn thành khi một người mới có thể xác định cách làm cho một phương thức trở thành public và hiểu hành vi --help được ghi trong tài liệu.

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

Mô tả

Here's a MWE:

#!/usr/bin/env python

from fire import Fire

class Example:
    def version(self):
        return "bla"
    def start(self):
        print("starting")
    def stop(self):
        print("stopping")

Fire(Example)

Running this script without arguments shows the available commands - OK:

NAME
    fire-bug.py

SYNOPSIS
    fire-bug.py COMMAND

COMMANDS
    COMMAND is one of the following:

     start

     stop

     version

But the more common (and usually safe) thing to do when a user is being introduced a new command, is to run it with a --help. However, Fire doesn't behave the same for this argument:

INFO: Showing help with the command 'fire-bug.py -- --help'.

NAME
    fire-bug.py

SYNOPSIS
    fire-bug.py -

Unless you use --verbose as well. Why is that? This is not trivial for a user to guess, and only reading the docs here led me to this conclusion. Plus, the docs don't mention how to make a class method a "public" method...

Ngôn ngữ chính
Python
Star
28.2k
Fork
1.5k
Không có pull request nào được merge trong 30 ngày

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 google/python-fire

Tất cả issue của google/python-fire

Issue tương tự

Thêm issue về Python

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.