Commit 175db2f9 authored by Eva Börgens's avatar Eva Börgens
Browse files

remove typos from docstring and export Docstrings as documentation

parent 8d72a548
......@@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>src.covariance API documentation</title>
<meta name="description" content="Module handling the computation of the covariances and uncertainties" />
<meta name="description" content="Functions handling the computation of the covariances and uncertainties" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
......@@ -22,13 +22,13 @@
<h1 class="title">Module <code>src.covariance</code></h1>
</header>
<section id="section-intro">
<p>Module handling the computation of the covariances and uncertainties</p>
<p>Functions handling the computation of the covariances and uncertainties</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Module handling the computation of the covariances and uncertainties
Functions handling the computation of the covariances and uncertainties
&#34;&#34;&#34;
import math
......
......@@ -28,15 +28,15 @@
<dl>
<dt><code class="name"><a title="src.covariance" href="covariance.html">src.covariance</a></code></dt>
<dd>
<div class="desc"><p>Module handling the computation of the covariances and uncertainties</p></div>
<div class="desc"><p>Functions handling the computation of the covariances and uncertainties</p></div>
</dd>
<dt><code class="name"><a title="src.input_arguments" href="input_arguments.html">src.input_arguments</a></code></dt>
<dd>
<div class="desc"><p>Module checking the input parameter</p></div>
<div class="desc"><p>Functions checking the input parameter</p></div>
</dd>
<dt><code class="name"><a title="src.io" href="io.html">src.io</a></code></dt>
<dd>
<div class="desc"><p>Module handling input and output</p></div>
<div class="desc"><p>Functions handling input and output</p></div>
</dd>
</dl>
</section>
......
......@@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>src.input_arguments API documentation</title>
<meta name="description" content="Module checking the input parameter" />
<meta name="description" content="Functions checking the input parameter" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
......@@ -22,13 +22,13 @@
<h1 class="title">Module <code>src.input_arguments</code></h1>
</header>
<section id="section-intro">
<p>Module checking the input parameter</p>
<p>Functions checking the input parameter</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Module checking the input parameter
Functions checking the input parameter
&#34;&#34;&#34;
from argparse import ArgumentParser, FileType, RawTextHelpFormatter
......
......@@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>src.io API documentation</title>
<meta name="description" content="Module handling input and output" />
<meta name="description" content="Functions handling input and output" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
......@@ -22,13 +22,13 @@
<h1 class="title">Module <code>src.io</code></h1>
</header>
<section id="section-intro">
<p>Module handling input and output</p>
<p>Functions handling input and output</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Module handling input and output
Functions handling input and output
&#34;&#34;&#34;
import sys
......
"""
Module handling the computation of the covariances and uncertainties
Functions handling the computation of the covariances and uncertainties
"""
import math
......
"""
Module checking the input parameter
Functions checking the input parameter
"""
from argparse import ArgumentParser, FileType, RawTextHelpFormatter
......
"""
Module handling input and output
Functions handling input and output
"""
import sys
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment