Materi
Menebak perilaku sebuah fungsi memakan waktu lebih lama daripada membaca satu paragraf dokumentasinya. Yang dibaca ada empat: nama parameternya, nilai bawaan tiap parameter, apa yang dikembalikan, dan galat apa yang dilemparkan bila masukannya tidak sesuai. Empat keterangan itu menjawab sebagian besar pertanyaan yang lahir saat menebak.
help(str.split)
# split(sep=None, maxsplit=-1) -> list of strings
print("a-b-c".split("-")) # ["a", "b", "c"]
print("a-b-c".split("-", 1)) # ["a", "b-c"]
Contoh di atas memperlihatkan parameter maxsplit yang jarang dipakai padahal menyelesaikan masalah yang sering muncul: memisahkan kode di depan dari sisa teks yang juga mengandung tanda pisah. Fungsi bawaan help() menampilkan keterangan yang sama tanpa meninggalkan program.
Ketika dokumentasi tetap tidak menjawab, pertanyaan yang dikirim ke orang lain memuat lima bagian: apa yang ingin dicapai, contoh terkecil yang bisa dijalankan apa adanya, hasil yang diharapkan, hasil yang terjadi lengkap dengan teks galatnya, dan apa yang sudah dicoba. Contoh yang bisa dijalankan itu bagian yang paling menentukan; tanpa itu, penjawab hanya bisa menebak.