docstring

5Nhiệt

2Trả lời

Python 3 - Phương pháp thừa kế docstring mà không phá vỡ trang trí hoặc vi phạm DRY

Câu hỏi này dường như xuất hiện thường xuyên trên cả StackOverflow và các nơi khác, nhưng tôi không thể tìm thấy giải pháp hoàn toàn thỏa đáng ở bất cứ đâu. Dường như có hai loại giải pháp phổ biến. N

10Nhiệt

1Trả lời

Tham số tham chiếu trong tài liệu Python

Tôi sử dụng tính năng Nhân sư và tính năng tự động phát để đảm bảo chúng tôi có tài liệu tốt trong dự án của mình. Vì vậy, tôi quen thuộc với info field lists và tôi đã quen với việc sử dụng cross-ref

6Nhiệt

2Trả lời

Dòng chiều dài tối đa docstring có khác với chuẩn PEP8 bình thường không?

Vì vậy, im nhìn vào một số mã và đưa nó lên tiêu chuẩn PEP 8 với sự trợ giúp của pylint và tôi nhận thấy rằng nếu tôi đang sử dụng dấu ngoặc kép cho một câu lệnh in nơi văn bản đã vượt quá 120 ký tự (

11Nhiệt

3Trả lời

Trong Django RestFramework, làm thế nào để thay đổi tài liệu Api Root?

Trong django RestFramework, có cách nào "chính thức" để tạo tài liệu cho "Api Root" không? Sau khi xem xét mã nguồn của RestFramework, tôi đã tìm thấy một công việc xung quanh bằng cách subclassing De

22Nhiệt

2Trả lời

Tài liệu về Clojure cho thư viện/không gian tên

Làm cách nào để thêm tài liệu và/hoặc nhận xét vào Clojure libaries/namespaces nói chung, tức là không chỉ cho các chức năng cụ thể trong không gian tên? Tôi đã nhận thấy rằng nguồn clojure sử dụng (c

26Nhiệt

4Trả lời

Làm thế nào để đưa một biến vào Python docstring

Vì vậy, tôi đang cố gắng để tạo ra một "năng động" docstring mà là một cái gì đó như thế này: ANIMAL_TYPES = ["mammals", "reptiles", "other"] def func(animalType): """ This is a sample function.

55Nhiệt

3Trả lời

Tuỳ chỉnh PyCharm docstring stubs (ví dụ: đối với các định dạng google docstring hoặc numpydoc)

PyCharm 2.7 (hoặc PyCharm 3) có hỗ trợ cho các chuỗi doctest và doctest tùy chỉnh không? Nếu vậy, làm cách nào để viết về loại tiện ích tùy chỉnh cụ thể này? Dự án hiện tại của tôi đã được chuẩn hóa b

9Nhiệt

1Trả lời

Ý nghĩa của các định dạng này trong docstring của xoắn là gì?

Trong mã nguồn của xoắn, nhiều tài liệu có chứa các định dạng như sau: L {xxx} hoặc C {xxx} hoặc dòng bắt đầu bằng '@', ý nghĩa của chúng là gì? ví dụ, trong xoắn/internet/interfaces.py: def registerP

47Nhiệt

7Trả lời

Có bất kỳ lựa chọn thay thế thực sự nào cho reStructuredText cho tài liệu Python không?

Tôi đang bắt đầu một dự án Python nguồn mở ngay và tôi đang cố gắng quyết định trước cách viết tài liệu của mình. Câu trả lời rõ ràng sẽ sử dụng reStructuredText và Sphinx với autodoc, bởi vì tôi thực

29Nhiệt

3Trả lời

Làm cách nào để tham chiếu tham số hàm Python được ghi lại bằng cách sử dụng đánh dấu Sphinx?

Tôi muốn tham chiếu một tham số chức năng được ghi chép trước đó ở nơi khác trong một chuỗi tài liệu Python. Hãy xem xét ví dụ sau đây (phải thừa nhận hoàn toàn nhân tạo): def foo(bar): """Perfor