Docstring fix for several modules

jtniehof · Sep 9, 2024 · 033dd0a · 033dd0a
1 parent 8f88744
commit 033dd0a
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/Doc/source/conf.py b/Doc/source/conf.py
@@ -123,7 +123,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'sphinxdoc'
-html_theme_options = { 'sidebarwidth': '350' }
+html_theme_options = { 'sidebarwidth': '300' }
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/spacepy/datamanager.py b/spacepy/datamanager.py
@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-Tool for locating the correct data file for a particular day and manipulating
-data and subsets generically.
+Tools for manipulating paths, data, and subsets
 
 Authors: Jon Niehof
 

diff --git a/spacepy/datamodel.py b/spacepy/datamodel.py
@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-Data model implementation meant to mirror the functionality of the data
-model output from pycdf.
+Data model conceptually similar to HDF5 and CDF.
 
 For more documentation :doc:`../datamodel`
 

diff --git a/spacepy/irbempy/__init__.py b/spacepy/irbempy/__init__.py
@@ -1,8 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-Wrapper for the fortran library irbem_lib;
-Reference: https://sourceforge.net/projects/irbem/
+Wrapper for the fortran library irbem_lib
+
+Reference: https://github.com/PRBEM/IRBEM
 
 D. Boscher, S. Bourdarie, T. P. O'Brien, T. Guild, IRBEM library V4.3, 2004-2008
 

diff --git a/spacepy/pybats/__init__.py b/spacepy/pybats/__init__.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
-Interface module for reading, manipulating, and visualizing
-BATS-R-US and SWMF output.
+Module for reading, manipulating, and visualizing BATS-R-US and SWMF output.
+
 For more information on the SWMF, please visit the
 `Center for Space Environment Modeling <http://csem.engin.umich.edu>`_.
 

diff --git a/spacepy/pycdf/__init__.py b/spacepy/pycdf/__init__.py
@@ -1,8 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-"""Python interface to the Common Data Format (CDF) library available
-at http://cdf.gsfc.nasa.gov/.
+"""Interface to the Common Data Format (CDF) library
+
+CDF available at http://cdf.gsfc.nasa.gov/.
 
 The interface is intended to be 'pythonic' rather than reproducing the
 C interface. To open or close a CDF and access its variables, see the `CDF`