menu
techminis

A naukri.com initiative

google-web-stories
Home

>

Technology News

>

1, 2, 3 St...
source image

Medium

1M

read

257

img
dot

Image Credit: Medium

1, 2, 3 Styles: How We Write Notes in Python

  • Here’s an overview of how you can structure docstrings in Python using these conventions:
  • 1. Instruction Manual Style: This style is like a detailed instruction manual, suitable for big projects and experienced developers.
  • 2. Sphinx Style: Commonly used with the Sphinx documentation generator, converts reST formatted docstrings into HTML documentation.
  • 3. Clear and Simple Style: Easier to use and understand, suitable for both big and small projects with a focus on clear information.
  • 4. NumPy Style: Popular in scientific and data communities, structured and works with Sphinx using the Napoleon extension.

Read Full Article

like

15 Likes

For uninterrupted reading, download the app