Differences

This shows you the differences between two versions of the page.

--- python_commenting [2019/12/11 22:34] – created jrseti
+++ python_commenting [2019/12/11 23:33] (current) – jrseti
@@ Line 1: / Line 1: @@
 ======Python Commenting======
-Example
+Good example: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+===Module Example, at top===
+<code>
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Determine flux densities of sources based on Perley and Butler, 2016.
+Using the method defined in Perley and Butler, 2016:
+https://arxiv.org/pdf/1609.05940.pdf calculate the flux densities of various
+sources from 1 to 10GHz and optionally produce a graph that is automatically
+displayed in a browser.
+Author: Jon Richards, jrseti@gmail.com
+Example:
+    Provide usage examples here
+"""
+</code>
+===Function Example===
 <code>