Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

This lesson is for members only. Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

Hint: You can adjust the default video playback speed in your account settings.
Hint: You can set the default subtitles language in your account settings.
Sorry! Looks like there’s an issue with video playback 🙁 This might be due to a temporary outage or because of a configuration issue with your browser. Please see our video player troubleshooting guide to resolve the issue.

Documenting With Docstrings (Part 1)

Docstrings are built-in strings that support project documentation. They are very useful and vary slightly depending on what you are creating them for (scripts, methods, functions, and so on). To learn more, check out Thonny: The Beginner-Friendly Python Editor.

rlivingston on Dec. 19, 2019

Multi-lined docstrings should elaborate more on the object beyond a summarisation

Have the following form:

  • A one-line summary line

  • A blank line proceeding the summary

  • Any further elaboration for the docstring

Should not that be: A blank line following the summary rather than proceeding the summary.

Andrew Stephen RP Team on Dec. 19, 2019

‘Proceeding’ can mean following, which in this case is what its intended use is. You might be thinking of ‘preceeding’?

Become a Member to join the conversation.