การเขียน docstring
สมมติว่าคุณกำลังจะเขียน Python package สำหรับประมวลผลภาษาธรรมชาติแบบโอเพนซอร์สที่ดีที่สุดในโลก เป้าหมายคือสร้างเครื่องมือที่เปลี่ยนวิธีการทำงานกับข้อความอิสระ เหมือนที่ numpy ทำกับ array, pandas ทำกับข้อมูลตาราง และ scikit-learn ทำกับ machine learning
ฟังก์ชันแรกที่เขียนคือ count_letter() ซึ่งรับ string และตัวอักษรหนึ่งตัว แล้วคืนค่าจำนวนครั้งที่ตัวอักษรนั้นปรากฏใน string เพื่อให้ผู้ใช้ package เข้าใจการทำงานของฟังก์ชันนี้ได้ง่าย จึงต้องเพิ่ม docstring ให้กับมัน สร้าง docstring แบบ Google Style สำหรับฟังก์ชันนี้โดยทำตามขั้นตอนต่อไปนี้
แบบฝึกหัดนี้เป็นส่วนหนึ่งของหลักสูตร
การเขียนฟังก์ชันใน Python
แบบฝึกหัดเชิงโต้ตอบแบบลงมือทำ
ลองทำแบบฝึกหัดนี้โดยเติมโค้ดตัวอย่างนี้ให้สมบูรณ์
# Add a docstring to count_letter()
def count_letter(content, letter):
____
if (not isinstance(letter, str)) or len(letter) != 1:
raise ValueError('`letter` must be a single character string.')
return len([char for char in content if char == letter])