Tôi muốn cung cấp các đoạn mã để hiển thị trường hợp người ta có thể sử dụng một phương thức hoặc lớp cụ thể trong Python. Làm thế nào tôi có thể làm điều đó? provide code snippets to show-case how one could use a particular method or class in python. How can I do that?
Trong Java, người ta có thể sử dụng def add_values[arr]:
"""
Add the values in ``arr``.
This is equivalent to Python ``sum`` of :meth:`pandas.Series.sum`.
Some sections are omitted here for simplicity.
"""
return sum[arr]
9 để làm như vậy. one could use
def add_values[arr]: """ Add the values in ``arr``. This is equivalent to Python ``sum`` of :meth:`pandas.Series.sum`. Some sections are omitted here for simplicity. """ return sum[arr]9 to do so.
Doctest là cách duy nhất? Khi tôi nhìn vào các tài liệu hiện có cho các gói điển hình [ví dụ: gấu trúc, numpy, v.v.], tôi không bao giờ thấy bất cứ điều gì khác ngoài DocTest nhằm kiểm tra phương thức và không chỉ định dạng văn bản là mã python. Vì vậy, nếu DocTest là cách duy nhất, điều gì sẽ là cách thích hợp để định dạng một đoạn mã để trông giống như các phiên Python tương tác? Tôi không muốn viết mã của mình trong một phiên tương tác mỗi lần và sau đó c+p nó trong tài liệu của tôi. Nó dường như không đúng. As I look at the existing docstrings for typical packages [e.g., pandas, numpy, etc], I never see anything other than doctest which is intended to test the method and not just to format text as python code. So, if doctest is the only way, what would be the proper way of formatting a snippet of code to look like interactive python sessions? I don't want to write my code in an interactive session each time and then c+p it in my docstring. It doesn't seem to be right.
Đã hỏi ngày 4 tháng 7 năm 2019 lúc 18:05Jul 4, 2019 at 18:05
Docstrings không phải là cách duy nhất. Nếu bạn đang sử dụng Sphinx để tạo tài liệu thì bạn nên đọc cái này.
Thí dụ
Here is something I want to talk about::