From ff59252d843befabf60f5f7424f27fca64d3e8d0 Mon Sep 17 00:00:00 2001
From: Lizzzka007 <gashchuk2011@mail.ru>
Date: Mon, 19 Jun 2023 01:47:10 +0300
Subject: [PATCH] .

---
 README.md | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 95854aa..f1a597f 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Import *plotter* module somewhere at the beginning of your script
 import plotter
 ```
 
-### get variable names from file 
+### Functions argument description
 Positional arguments for functions `plotter.dump, plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`:
 <ol>
   <li>filename</li>
@@ -48,17 +48,19 @@ Optional arguments for functions `plotter.plot, plotter.ani_plot, plotter.plot_c
 
 The argument `filename` is the name of a file to read for functions `plotter.plot, plotter.plot_contour, plotter.avg_plot` and the template of filenames for the function `plotter.ani_plot`. `out` is the output directory to save a function result. `oname` is the output name of a function result. `var` is a list or a single variable denoting names(name) to process (may be got from `plotter.dump` function). `mval` is a list or a single variable denoting maximum valid absolute values(value) of `var` variables: values which satisfy the condition `var` > `mval` are set as NaN. 
 
+### Get variable names from file 
+
 Use `plotter.dump(filename)` to get variable names in file `filename`.
 Data must be stored either in *Tecplot* ASCII file with *.plt* or *.nsx* extensions. 
 
-### plotting a 1D data
+### Plotting a 1D data
 Calling 
 ```python
 plotter.plot(filename)
 ```
 saves XY plots of 1D data contained in file `filename` into *out/oname* file.
 
-### plotting animation of a 1D data
+### Plotting animation of a 1D data
 
 Calling 
 ```python
@@ -66,14 +68,14 @@ plotter.ani_plot(filename)
 ```
 saves animation of XY plots of 1D data contained in file `filename` into *out/oname* file.
 
-### plotting a 2D data
+### Plotting a 2D data
 Calling 
 ```python
 plotter.plot_contour(filename)
 ```
 saves XY contour plots of 2D data contained in file `filename` into *out/oname* file.
 
-### plotting an averaged by x and y coordinates 3D data
+### Plotting an averaged by x and y coordinates 3D data
 Calling 
 ```python
 plotter.avg_plot(filename)
-- 
GitLab