typo in doccs (#15)

Co-authored-by: pegerto-fernandez-ck <pegerto.fernandez@creditkarma.com>
pegerto · Nov 21, 2023 · c18431c · c18431c
1 parent 67238bb
commit c18431c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 6 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,5 +1,6 @@
 API Documentation
 =================
+This section describe the MDA Kit API
 
 .. autosummary::
    :toctree: autosummary

diff --git a/docs/source/autosummary/mdakit_sasa.analysis.sasaanalysis.rst b/docs/source/autosummary/mdakit_sasa.analysis.sasaanalysis.rst
@@ -1,4 +1,4 @@
-mdakit\_sasa.analysis.sasaanalysis
+mdakit\_sasa.analysis.sasaanalysis
 ==================================
 
 .. automodule:: mdakit_sasa.analysis.sasaanalysis

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -6,7 +6,7 @@ This software is available and tested on Linux/Mac/Windows
 Installation
 ------------
 
-This sofware can be installed from sources using the documentation under `github`_,  alterantive using a python package manager.
+This sofware can be installed from source using the documentation under `github`_,  alterantive using a python package manager.
 
 
 Using `Pip`_ ::
@@ -19,7 +19,7 @@ Using `Conda`_ ::
 
 
 
-SASA for a trajectory 
+SASA analisys
 ---------------------
 
 If you already familiar with MDAnaysis the first steps are simple::

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,12 +6,15 @@
 Welcome to mdakit-sasa's documentation!
 =========================================================
 
-This MDAKit allows enables the calculation of Solvant Accessible Surface Area ( SASA) with MDAnaysis. 
+This MDAKit module facilitates the calculation of Solvant Accessible Surface Area (SASA) using MDAnaysis.
 
 .. note::
    The underline calculation and algorithm implementation is based on Freesasa, by Simon Mitternacht (2016) FreeSASA: An open source C library for solvent accessible surface area calculation. F1000Research 5:189 (doi: 10.12688/f1000research.7931.1)
 
-This software enable the calculation to be store for a trajectory and seamlessly integrates FreeSASA into MDAnaysis.
+
+
+This kit is a standalone package that utilizes MDAnalysis components to addresss the specific calculation of the solvant accessible area during a molecular dynamics simulatio.
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/mdakit_sasa/analysis/sasaanalysis.py b/mdakit_sasa/analysis/sasaanalysis.py
@@ -2,7 +2,10 @@
 SASAAnalysis --- :mod:`mdakit_sasa.analysis.SASAAnalysis`
 ===========================================================
 
-This module contains the :class:`SASAAnalysis` class.
+This module contains the :class:`SASAAnalysis` class, this class follow
+the standarised :class:`AnalysisBase` that will be familiar for MDAnalisys users.
+
+This module is the entry point for this MDA Kit.
 
 """
 from typing import Union, TYPE_CHECKING