markdown: fix lint errors (#851)

OSGeo · Jan 24, 2023 · 422b7b2 · 422b7b2
1 parent 3de008e
commit 422b7b2
Show file tree

Hide file tree

Showing 17 changed files with 914 additions and 1,037 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -15,6 +15,7 @@ A clear and concise description of what the bug of the addon is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Compute '....'
@@ -27,11 +28,13 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **System description (please complete the following information):**
+
 - Operating System: [e.g. Windows, Linux, ... incl. version]
 - GRASS GIS version [e.g. 7.8.1]
 <!---
 - details about further software components
-    - run `g.version -rge` in a GRASS GIS terminal session or check in the GUI menu "Help > About"
+    - run `g.version -rge` in a GRASS GIS terminal session or check in the
+      GUI menu "Help > About"
 --->
 
 **Additional context**

diff --git a/README.md b/README.md
@@ -69,8 +69,8 @@ and finally open a [pull request](https://help.github.com/en/articles/about-pull
 If you aim at full write access, this must be formally requested, see here for details:
 <https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>
 
-In either case, please note the following submitting rules: To successfully submit your
-GRASS GIS AddOn module here, please check
+In either case, please note the following submitting rules: To successfully
+submit your GRASS GIS AddOn module here, please check
 
 <https://grass.osgeo.org/development/>
 
@@ -82,4 +82,4 @@ and RFC2 (Legal aspects of submission):
 
 Also read submitting instructions before committing any changes!
 
-<https://trac.osgeo.org/grass/wiki/Submitting>
+<https://trac.osgeo.org/grass/wiki/Submitting>
diff --git a/src/imagery/i.fusion.hpf/README.md b/src/imagery/i.fusion.hpf/README.md
@@ -26,28 +26,29 @@ Source: Gangkofner, 2008
 
 ## From the original paper
 
-> Step 1: HP Filtering of the High-resolution Image to Extract the Structural
-> Detail
->
-> Step 2: Adding the HP Filtered Image to Each Band of the Multispectral Image
-> Using a Standard Deviation-based Injection Model
->
-> Step 3: Linear Histogram Match to Adapt SD and Mean of the Merged Image Bands
-> to Those of the Original MS Image Bands
->
-> Figure 1:
-
-     ____________________________________________________________________________
-    +                                                                            +
-    | Pan Img ->  High Pass Filter  ->  HP Img                                   |
-    |                                      |                                     |
-    |                                      v                                     |
-    | MSx Img ->  Weighting Factors ->  Weighted HP Img                          |
-    |       |                              |                                     |
-    |       |                              v                                     |
-    |       +------------------------>  Addition to MSx Img  =>  Fused MSx Image |
-    +____________________________________________________________________________+
-
+```text
+Step 1: HP Filtering of the High-resolution Image to Extract the Structural
+Detail
+
+Step 2: Adding the HP Filtered Image to Each Band of the Multispectral Image
+Using a Standard Deviation-based Injection Model
+
+Step 3: Linear Histogram Match to Adapt SD and Mean of the Merged Image Bands
+to Those of the Original MS Image Bands
+
+Figure 1:
+
+ ____________________________________________________________________________
++                                                                            +
+| Pan Img ->  High Pass Filter  ->  HP Img                                   |
+|                                      |                                     |
+|                                      v                                     |
+| MSx Img ->  Weighting Factors ->  Weighted HP Img                          |
+|       |                              |                                     |
+|       |                              v                                     |
+|       +------------------------>  Addition to MSx Img  =>  Fused MSx Image |
++____________________________________________________________________________+
+```
 
 ## Installation
 
@@ -57,33 +58,37 @@ See [GRASS Addons SVN repository, README file, Installation - Code Compilation](
 
 ### Steps
 
-Making the script `i.fusion.hpf` available from within any GRASS-GIS ver. 7.x session, may be done via the following steps:
+Making the script `i.fusion.hpf` available from within any GRASS-GIS ver. 7.x
+session, may be done via the following steps:
 
 1. launch a GRASS-GIS’ ver. 7.x session
 2. navigate into the script’s source directory
 3. execute `make MODULE_TOPDIR=$GISBASE`
 
 ## Usage
 
-After installation, from within a GRASS-GIS session, see help details via `i.fusion.hpf --help`
+After installation, from within a GRASS-GIS session, see help details via
+`i.fusion.hpf --help`
 
 ### Remarks
 
 * easy to use, i.e.:
   * for one band `i.fusion.hpf pan=Panchromatic msx=${Band}`
   * for multiple bands `i.fusion.hpf pan=Panchromatic msx=Red,Green,Blue,NIR`
-* easy to test various parameters that define the High-Pass filter’s *kernel size* and *center value*
+* easy to test various parameters that define the High-Pass filter’s
+  *kernel size* and *center value*
 * should work with **any** kind of imagery (think of bitness)
-* the "black border" effect, possibly caused due to a non-perfect match of the high vs. the low resolution
-  of the input images, can be trimmed out by using the `trim` option --a floating point "trimming factor"
-  with which to multiply the pixel size of the low resolution image-- and shrink the extent of the output image
+* the "black border" effect, possibly caused due to a non-perfect match of the
+  high vs. the low resolution of the input images, can be trimmed out by using
+  the `trim` option --a floating point "trimming factor" with which to multiply
+  the pixel size of the low resolution image-- and shrink the extent of the
+  output image
 
 ## Implementation notes
 
 * First commit on Sat Oct 25 12:26:54 2014 +0300
 * Working state reached on Tue Nov 4 09:28:25 2014 +0200
 
-
 ## To Do
 
 * Go through <http://trac.osgeo.org/grass/wiki/Submitting/Python>
@@ -109,8 +114,9 @@ After installation, from within a GRASS-GIS session, see help details via `i.fus
   PHOTOGRAMMETRIC ENGINEERING & REMOTE SENSING, 74(9):1107–1118.
 * “ERDAS IMAGINE.” Accessed March 19, 2015. <http://doc.hexagongeospatial.com/ERDAS%20IMAGINE/ERDAS_IMAGINE_Help/#ii_hpfmerge_mergedialog.htm>.
 
-
-- Aniruddha Ghosh & P.K. Joshi (2013) Assessment of pan-sharpened very high-resolution WorldView-2 images, International Journal of Remote Sensing, 34:23, 8336-8359
+* Aniruddha Ghosh & P.K. Joshi (2013) Assessment of pan-sharpened very
+  high-resolution WorldView-2 images, International Journal of Remote Sensing,
+  34:23, 8336-8359
 
 ## Ευχαριστώ
 

diff --git a/src/imagery/i.landsat8.swlst/README.md b/src/imagery/i.landsat8.swlst/README.md
@@ -4,7 +4,6 @@
 algorithm, estimating land surface temperature (LST), from the Thermal Infra-Red
 Sensor (TIRS) aboard Landsat 8 with an accuracy of better than 1.0 K.
 
-
 ## Quick examples
 
 After installation (see section *Installation* below), from within a GRASS-GIS
@@ -27,26 +26,27 @@ where:
 A faster call is to use existing maps for all in-between
 processing steps: at-satellite temperatures, cloud and emissivity maps.
 
-* At-satellite temperature maps (options `t10`, `t11`) may be derived via
+- At-satellite temperature maps (options `t10`, `t11`) may be derived via
   the `i.landsat.toar` module. Note that `i.landsat.toar` does not
   process single bands selectively.
 
-* The `clouds` option can be any user-defined map. Essentialy, it applies
+- The `clouds` option can be any user-defined map. Essentialy, it applies
   the given map as an inverted mask.
 
-* The emissivity maps, derived by the module itself, can be saved once
+- The emissivity maps, derived by the module itself, can be saved once
   via the `emissivity_out` and `delta_emissivity_out` options and used
   afterwards via the `emissivity` and `delta_emissivity` options. Expert
   users, however, may use emissivity maps from other sources directly.
   An example command may be:
 
 ```bash
-  i.landsat8.swlst t10=T10 t11=T11 clouds=Cloud_Map emissivity=Average_Emissivity_Map delta_emissivity=Delta_Emissivity_Map landcover=FROM_GLC -k -c
+  i.landsat8.swlst t10=T10 t11=T11 clouds=Cloud_Map \
+      emissivity=Average_Emissivity_Map delta_emissivity=Delta_Emissivity_Map \
+          landcover=FROM_GLC -k -c
 ```
 
 For details and more examples, read the manual.
 
-
 ## Description
 
 The algorithm removes the atmospheric effect through differential