Skip to content

Commit

Permalink
docsitre updates
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Oct 29, 2023
1 parent 8ff02fe commit fad5c29
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 20 deletions.
16 changes: 8 additions & 8 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,15 @@ Words
plot_years
plot_wordcloud

Utilities
---------
File Management
---------------

Utilities and file management.
File management and input / output.

File IO
~~~~~~~
I/O
~~~

.. currentmodule:: lisc.utils.io
.. currentmodule:: lisc.io.io

.. autosummary::
:toctree: generated/
Expand All @@ -246,7 +246,7 @@ File IO
Database Management
~~~~~~~~~~~~~~~~~~~

.. currentmodule:: lisc.utils.db
.. currentmodule:: lisc.io.db

.. autosummary::
:toctree: generated/
Expand All @@ -260,7 +260,7 @@ Database Management
File Utilities
~~~~~~~~~~~~~~

.. currentmodule:: lisc.utils.utils
.. currentmodule:: lisc.io.utils

.. autosummary::
:toctree: generated/
Expand Down
2 changes: 1 addition & 1 deletion examples/plot_db_terms.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
###################################################################################################

# Import a function to create a LISC database file structure
from lisc.utils.db import create_file_structure
from lisc.io.db import create_file_structure

###################################################################################################
# SCDB Database Structure
Expand Down
2 changes: 1 addition & 1 deletion tutorials/plot_00-Overview.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
###################################################################################################

# Import a helper function to create a LISC file structure
from lisc.utils.db import create_file_structure
from lisc.io import create_file_structure

###################################################################################################
#
Expand Down
4 changes: 2 additions & 2 deletions tutorials/plot_01-WordsCollection.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
from lisc import Words

# Import the SCDB object, which organizes a database structure for saved data
from lisc.utils.db import SCDB
from lisc.io import SCDB

# Import a utility function for saving out collected data
from lisc.utils.io import save_object
from lisc.io import save_object

###################################################################################################
# Words Object
Expand Down
3 changes: 1 addition & 2 deletions tutorials/plot_02-WordsAnalysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
from lisc.data import Articles, ArticlesAll

# Import database and IO utilities to reload our previously collected data
from lisc.utils.db import SCDB
from lisc.utils.io import load_object
from lisc.io import SCDB, load_object

# Import plots that are available for words data
from lisc.plts.words import plot_wordcloud
Expand Down
4 changes: 2 additions & 2 deletions tutorials/plot_03-CountsCollection.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
from lisc import Counts

# Import the SCDB object, which defines a database structure for saved data
from lisc.utils.db import SCDB
from lisc.io import SCDB

# Import a utility function for saving out collected data
from lisc.utils.io import save_object
from lisc.io import save_object

###################################################################################################
# Counts Object
Expand Down
3 changes: 1 addition & 2 deletions tutorials/plot_04-CountsAnalysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
###################################################################################################

# Import database and IO utilities to reload our previously collected data
from lisc.utils.db import SCDB
from lisc.utils.io import load_object
from lisc.io import SCDB, load_object

# Import plots that are available for co-occurrence analysis
from lisc.plts.counts import plot_matrix, plot_clustermap, plot_dendrogram
Expand Down
3 changes: 1 addition & 2 deletions tutorials/plot_06-MetaData.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
Exploring metadata collected and saved during data collections.
"""

from lisc.utils.db import SCDB
from lisc.utils.io import load_object
from lisc.io import SCDB, load_object

###################################################################################################
# Metadata
Expand Down

0 comments on commit fad5c29

Please sign in to comment.