add __init__.py comments for subpackages

bird-house · Nov 28, 2018 · a6ff49e · a6ff49e
1 parent 11815e5
commit a6ff49e
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/eggshell/__init__.py b/eggshell/__init__.py
@@ -1,7 +1,12 @@
 # -*- coding: utf-8 -*-
 
-"""Top-level package for Eggshell."""
+"""Top-level package for Eggshell.
+
+eggshell is a function library to be used in birds of birdhouse.
+eggshell is organised in subpackages ordered thematically.
+
+"""
 
 __author__ = """Nils Hempelmann"""
-__email__ = 'info@nilshempelmann.de'
+__email__ = 'info[@]nilshempelmann.de'
 __version__ = '0.4.0'
diff --git a/eggshell/eo/__init__.py b/eggshell/eo/__init__.py
@@ -0,0 +1,4 @@
+"""EO  subpackage of Eggshell.
+
+eggshell.eo contains functions related to Earth-Obersvation analysis
+"""
diff --git a/eggshell/nc/__init__.py b/eggshell/nc/__init__.py
@@ -0,0 +1,4 @@
+"""NC subpackage of Eggshell
+
+eggshell.nc contains functions related to netCDF4 processing
+"""
diff --git a/eggshell/visual/__init__.py b/eggshell/visual/__init__.py
@@ -0,0 +1,5 @@
+"""Visual subpackage of eggshell
+
+eggshell.visula contains functions for ploting and data visualisation purpose
+
+"""