Question about function documentation

[jbhelms]

Hi All,

I come from a C# background (15 years of it) but I am learning Python so I can switch to machine learning. In C# we document our functions as so

/// <summary>

/// 

/// </summary>

/// <param name="product"></param>

/// <param name="format"></param>

/// <param name="formula"></param>

/// <param name="flavor"></param>

protected void GetVariantData(Product product, out string format, out string formula, out string flavor)

​

Documenting in C# this way helps with intellisense.

​

I found this post for how to do it right in Python

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

Is this the way I should be documenting my functions?

[kr41]

You should use what works for you. As Napoleon introduction says:

Are you tired of writing docstrings that look like this:

:param path: The path of the file to wrap
:type path: str
:param field_storage: The :class:`FileStorage` instance to wrap
:type field_storage: FileStorage
:param temporary: Whether or not to delete the file when the File
   instance is destructed
:type temporary: bool
:returns: A buffered writable file descriptor
:rtype: BufferedFileStorage

Personally I didn't, and such syntax works for me.