DOC: update code statement block

Update the code comments to include the pub release block.
pysat · Sep 6, 2024 · df0670f · df0670f
1 parent 39eb30a
commit df0670f
Show file tree

Hide file tree

Showing 11 changed files with 52 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,11 @@
 # -*- coding: utf-8 -*-
-
+# Copyright (C) 2022, pysat development team
+# Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# -----------------------------------------------------------------------------
 """Configuration file for the Sphinx documentation builder.
 
 Note

diff --git a/pysatSeasons/__init__.py b/pysatSeasons/__init__.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """pysatSeasons.
 

diff --git a/pysatSeasons/_core.py b/pysatSeasons/_core.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 import pandas as pds
 import xarray as xr

diff --git a/pysatSeasons/avg.py b/pysatSeasons/avg.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Instrument independent seasonal averaging routine.
 

diff --git a/pysatSeasons/occur_prob.py b/pysatSeasons/occur_prob.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Occurrence probability routines, daily or by orbit.
 

diff --git a/pysatSeasons/plot.py b/pysatSeasons/plot.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Support scatterplot production over seasons of interest."""
 

diff --git a/pysatSeasons/tests/__init__.py b/pysatSeasons/tests/__init__.py
@@ -1,3 +1,12 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (C) 2022, pysat development team
+# Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# -----------------------------------------------------------------------------
 """Unit and Integration Tests for pysatSeasons.
 
 Note

diff --git a/pysatSeasons/tests/test_avg.py b/pysatSeasons/tests/test_avg.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test the pysat averaging code."""
 

diff --git a/pysatSeasons/tests/test_core.py b/pysatSeasons/tests/test_core.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test the pysat _core code."""
 

diff --git a/pysatSeasons/tests/test_occur_prob.py b/pysatSeasons/tests/test_occur_prob.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test pysatSeasons occur_prob object and code."""
 

diff --git a/pysatSeasons/tests/test_plot.py b/pysatSeasons/tests/test_plot.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test pysatSeasons plotting code."""