Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Docformatter not formatting multi-line format of docstring

Đang mở
#265 0 bình luận 0 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
tooling

Hướng nghiên cứu

Tái hiện vấn đề với docformatter và Python 3.10.1 bằng đầu vào được hiển thị trong báo cáo, sau đó so sánh docstring được tạo với đầu ra mong đợi. Theo dõi cách formatter xử lý các docstring nhiều dòng và bổ sung coverage cho trường hợp này; hoàn thành có nghĩa là đầu ra khớp với định dạng mong đợi mà không làm hồi quy hành vi hiện có.

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

Mô tả

C: convention P: bug U: high

I'm running the latest version of docformatter (as well as 1.7.3, 1.6.5, 1.3.1) with python 3.10.1.

Input:

def launch_rocket():
    """Launch
the
rocket. Go colonize space."""

expected:

def launch_rocket():
    """Launch the rocket.

    Go colonize space.
    """

actual output:

def launch_rocket():
    """Launch
    the
    rocket. Go colonize space.
    """
Ngôn ngữ chính
Python
Star
598
Fork
97
Merge trung bình
1 ngày 8 giờ
Pull request đã merge (30 ngày)
11

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 PyCQA/docformatter

Tất cả issue của PyCQA/docformatter

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.