Using docstrings to document your code (Python 3)

Using docstrings to document your code

A docstring is a string that occurs as the first statement in a module, function, class, or method definition. Such a docstring becomes the __doc__ special attribute of that object. You can read docstrings with the help() function.

Edit and run this Python 3 example code

This code is editable and runnable. You can run "Using docstrings to document your code" by pressing the run button. It will be executed in our backend and the result (stdout and stderr) is displayed in addition tabs.

Share "Using docstrings to document your code"

Share this crumb (Using docstrings to document your code) with your friends and colleagues to help them learn more about Python 3 programming.

Twitter, Facebook, LinkedIn

On Twitter, Facebook, and LinkedIn, simply paste the URL in your post and watch the magic unfold.

IFRAME

If you want to embed the crumb in an iframe, use the following code:

oEmbed (WordPress)

We support oEmbed, but most sites use allowlisting. On WordPress, oEmbed is supported out of the box, but see the note below.

If you plan to use crumb.sh heavily on Wordpress, you can use the following PHP code to allowlist our site and unlock all the functionalities of our crumbs:
wp_oembed_add_provider( 'https://crumb.sh/*', 'https://crumb.sh/oembed/' );

Embed.ly

Embed.ly is a service that allows you to embed content from other sites. We will request to be added to the list of trusted sites once we're out of beta.