Skip to content

Commit 429a884

Browse files
authored
docs: fix line-length (#5174)
1 parent 3c3e286 commit 429a884

File tree

20 files changed

+134
-71
lines changed

20 files changed

+134
-71
lines changed

.markdownlint.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@ fix: true
88
MD041: false # first-line-h1
99

1010
# Errors from .html to .md rename (first step in HTML to Markdown conversion)
11-
line-length: false
11+
MD013:
12+
code_blocks: false
13+
tables: false
1214
# The block above this is to be eventually removed.

db/drivers/postgres/grass-pg.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ v.info -t test
115115
116116
#### Geometry Converters
117117
118-
- [PostGIS with
119-
shp2pgsql](https://postgis.net/workshops/postgis-intro/loading_data.html#loading-with-shp2pgsql):
118+
- [PostGIS with shp2pgsql](https://postgis.net/workshops/postgis-intro/loading_data.html#loading-with-shp2pgsql):
120119
`shp2pgsql -D lakespy2 lakespy2 test > lakespy2.sql`
121120
- [e00pg](https://e00pg.sourceforge.net/): E00 to PostGIS filter, see
122121
also *[v.in.e00](v.in.e00.md)*.

general/g.proj/g.proj.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ proprietary GIS. In addition, if one of the parameters *georef*, *wkt*,
2222
project, the CRS information is imported from an external source as
2323
follows:
2424

25-
- With **georef**=*filename* g.proj attempts to invoke GDAL and OGR in turn to read a georeferenced
26-
file *filename*. The CRS information will be read from this file. If the
27-
file is not georeferenced or cannot be read, XY (unprojected) will be
28-
used.
29-
30-
- When using **wkt**=*filename*, the file *filename* should contain a CRS description in WKT format with
31-
or without line-breaks (e.g. a '.prj' file). If **-** is given for the
32-
filename, the WKT description will be read from stdin rather than a
33-
file.
25+
- With **georef**=*filename* g.proj attempts to invoke GDAL and OGR in turn
26+
to read a georeferenced file *filename*. The CRS information will be read
27+
from this file. If the file is not georeferenced or cannot be read,
28+
XY (unprojected) will be used.
29+
30+
- When using **wkt**=*filename*, the file *filename* should contain a CRS
31+
description in WKT format with or without line-breaks (e.g. a '.prj' file).
32+
If **-** is given for the filename, the WKT description will be read from
33+
stdin rather than a file.
3434

3535
- **proj4**=*description* should be a CRS description in [PROJ](https://proj.org/)
3636
format, enclosed in quotation marks if there are any spaces. If **-** is

general/g.region/g.region.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -105,21 +105,21 @@ always updated unless **-u** was specified.
105105

106106
### Additional parameter information
107107

108-
Option **zoom** shrinks current region settings to the smallest region encompassing all
109-
non-NULL data in the named raster map layer that fall inside the user's
110-
current region. In this way you can tightly zoom in on isolated clumps
111-
within a bigger map.
108+
Option **zoom** shrinks current region settings to the smallest region
109+
encompassing all non-NULL data in the named raster map layer that fall
110+
inside the user's current region. In this way you can tightly zoom in on
111+
isolated clumps within a bigger map.
112112

113113
If the user also includes the **raster** option on the command
114114
line, **zoom** will set the current region settings to the
115115
smallest region encompassing all non-NULL data in the named **zoom** map
116116
that fall inside the region stated in the cell header for the named
117117
**raster** map.
118118

119-
Option **align** sets the current resolution equal to that of the provided raster map, and
120-
align the current region to a row and column edge in the named map.
121-
Alignment only moves the existing region edges outward to the edges of
122-
the next nearest cell in the named raster map - not to the named map's
119+
Option **align** sets the current resolution equal to that of the provided
120+
raster map, and align the current region to a row and column edge in the
121+
named map. Alignment only moves the existing region edges outward to the edges
122+
of the next nearest cell in the named raster map - not to the named map's
123123
edges. To perform the latter function, use the **raster**=*name* option.
124124

125125
## EXAMPLES

imagery/i.gensig/i.gensig.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ member of the imagery group. Signatures generated for one scene are
2121
suitable for classification of other scenes as long as they consist of
2222
same raster bands (semantic labels match).
2323

24-
Input **trainingmap** map must be prepared by the user in advance using vector or raster
24+
Input **trainingmap** map must be prepared by the user in advance
25+
using vector or raster
2526
digitizer. Of course other methods could be devised by the user for
2627
creating this training map - *i.gensig* makes no assumption about the
2728
origin of this map layer. It simply creates signatures for the classes
@@ -41,7 +42,8 @@ select a subset of all the band files that form an image.
4142

4243
Input **signaturefile** is the resultant signature file (containing the means and
4344
covariance matrices) for each class in the training map that is
44-
associated with the band files in the subgroup select. Resultant singature file can be used with any other
45+
associated with the band files in the subgroup select.
46+
Resultant singature file can be used with any other
4547
imagery group as long as semantic labels match.
4648

4749
## NOTES

imagery/i.gensigset/i.gensigset.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ An usage example can be found in [i.smap](i.smap.md) documentation.
2828

2929
### Parameters
3030

31-
The **trainingmap** raster layer, supplied as input by the user, has some of its pixels
32-
already classified, and the rest (probably most) of the pixels
31+
The **trainingmap** raster layer, supplied as input by the user, has some of
32+
its pixels already classified, and the rest (probably most) of the pixels
3333
unclassified. Classified means that the pixel has a non-zero value and
3434
unclassified means that the pixel has a zero value.
3535

@@ -47,16 +47,17 @@ Option **group** is the name of the group that contains the band files which
4747
comprise the image to be analyzed. The *[i.group](i.group.md)* command
4848
is used to construct groups of raster layers which comprise an image.
4949

50-
Option **subgroup** names the subgroup within the group that selects a subset of the
51-
bands to be analyzed. The *[i.group](i.group.md)* command is also used
50+
Option **subgroup** names the subgroup within the group that selects a subset
51+
of the bands to be analyzed. The *[i.group](i.group.md)* command is also used
5252
to prepare this subgroup. The subgroup mechanism allows the user to
5353
select a subset of all the band files that form an image.
5454

5555
Option **signaturefile** is the resultant signature file (containing the means and
5656
covariance matrices) for each class in the training map that is
5757
associated with the band files in the subgroup selected.
5858

59-
Option **maxsig** is the maximum number of sub-signatures in any class (default: 5).
59+
Option **maxsig** is the maximum number of sub-signatures in any class
60+
(default: 5).
6061

6162
The spectral signatures which are produced by this program are "mixed"
6263
signatures (see [NOTES](#notes)). Each signature contains one or more

imagery/i.maxlik/i.maxlik.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,10 @@ r.mapcalc "lsat7_2002_cluster_classes_filtered = \
9191
![Output raster map with pixels classified (10 classes)](i_maxlik_classes.png)
9292
*Output raster map with pixels classified (10 classes)*
9393

94-
![Output raster map with rejection probability values (pixel classification confidence levels)](i_maxlik_rejection.png)
95-
*Output raster map with rejection probability values (pixel classification confidence levels)*
94+
![Output raster map with rejection probability values
95+
(pixel classification confidence levels)](i_maxlik_rejection.png)
96+
*Output raster map with rejection probability values
97+
(pixel classification confidence levels)*
9698

9799
## SEE ALSO
98100

imagery/i.segment/i.segment.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,11 @@ the distance calculation will also take into account the shape
6363
characteristics of the segments. The normal distances are then
6464
multiplied by the input radiometric weight. Next an additional
6565
contribution is added:
66-
`(1-radioweight) * {smoothness * smoothness weight + compactness * (1-smoothness weight)}`,
66+
67+
```text
68+
(1-radioweight) * {smoothness * smoothness weight + compactness * (1-smoothness weight)}
69+
```
70+
6771
where `compactness = Perimeter Length / sqrt( Area )` and
6872
`smoothness = Perimeter Length / Bounding Box`. The perimeter length is
6973
estimated as the number of pixel sides the segment has.

lib/init/grass.md

+51-18
Original file line numberDiff line numberDiff line change
@@ -243,50 +243,83 @@ HTML web browser to use for displaying help pages.
243243

244244
The following are some examples of how you could start GRASS
245245

246-
**grass**
247246
Start GRASS using the default user interface. The user will be prompted
248247
to choose the appropriate project and mapset.
249248

250-
**grass --gui**
249+
```sh
250+
grass
251+
```
252+
251253
Start GRASS using the graphical user interface. The user will be
252254
prompted to choose the appropriate project and mapset.
253255

254-
**grass --text**
256+
```sh
257+
grass --gui
258+
```
259+
255260
Start GRASS using the text-based user interface. Appropriate project and
256261
mapset must be set by environmental variables (see examples below)
257262
otherwise taken from the last GRASS session.
258263

259-
**grass --gtext**
264+
```sh
265+
grass --text
266+
```
267+
260268
Start GRASS using the text-based user interface. The user will be
261269
prompted to choose the appropriate project and mapset.
262270

263-
**grass $HOME/grassdata/spearfish70/user1**
271+
```sh
272+
grass --gtext
273+
```
274+
264275
Start GRASS using the default user interface and automatically launch
265-
into the given mapset, bypassing the mapset selection menu.
276+
into the given mapset, bypassing the mapset selection menu:
277+
278+
```sh
279+
grass $HOME/grassdata/spearfish70/user1
280+
```
266281

267-
**grass --gui -**
268282
Start GRASS using the graphical user interface and try to obtain the
269-
project and mapset from environment variables.
283+
project and mapset from environment variables:
284+
285+
```sh
286+
grass --gui -
287+
```
270288

271-
**grass -c EPSG:4326 $HOME/grassdata/myproject**
272289
Creates a new GRASS project with EPSG code 4326 (latitude-longitude,
273-
WGS84) in the specified GISDBASE
290+
WGS84) in the specified GISDBASE:
291+
292+
```sh
293+
grass -c EPSG:4326 $HOME/grassdata/myproject
294+
```
274295

275-
**grass -c EPSG:5514:3 $HOME/grassdata/myproject**
276296
Creates a new GRASS project with EPSG code 5514 (S-JTSK / Krovak East
277297
North - SJTSK) with datum transformation parameters used in Czech
278-
Republic in the specified GISDBASE
298+
Republic in the specified GISDBASE:
299+
300+
```sh
301+
grass -c EPSG:5514:3 $HOME/grassdata/myproject
302+
```
279303

280-
**grass -c XY $HOME/grassdata/gnomonic --exec g.proj -c proj4='+proj=gnom +lat_0=90 +lon_0=-50'**
281304
Creates a new GRASS project from PROJ definition string (here:
282305
[gnomonic](https://proj4.org/operations/projections/gnom.html)) in the
283-
specified GISDBASE
306+
specified GISDBASE:
307+
308+
```sh
309+
grass -c XY $HOME/grassdata/gnomonic --exec g.proj -c proj4='+proj=gnom +lat_0=90 +lon_0=-50'
310+
```
311+
312+
Creates a new GRASS project based on georeferenced Shapefile:
313+
314+
```sh
315+
grass -c myvector.shp $HOME/grassdata/myproject
316+
```
284317

285-
**grass -c myvector.shp $HOME/grassdata/myproject**
286-
Creates a new GRASS project based on georeferenced Shapefile
318+
Creates a new GRASS project based on georeferenced GeoTIFF file:
287319

288-
**grass -c myraster.tif $HOME/grassdata/myproject**
289-
Creates a new GRASS project based on georeferenced GeoTIFF file
320+
```sh
321+
grass -c myraster.tif $HOME/grassdata/myproject
322+
```
290323

291324
### Batch jobs with the exec interface
292325

ps/ps.map/ps.map.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,10 @@ zero, the default vertical location is used.
9292
**font** *font name*
9393
The name of the PostScript font. Fonts present in all PostScript
9494
implementations are:
95-
`Times-Roman, Times-Italic, Times-Bold, Times-BoldItalic, Helvetica, Helvetica-Oblique, Helvetica-Bold, Helvetica-BoldOblique, Courier, Courier-Oblique, Courier-Bold, and Courier-BoldOblique`.
95+
*Times-Roman*, *Times-Italic*, *Times-Bold*, *Times-BoldItalic*, *Helvetica*,
96+
*Helvetica-Oblique*, *Helvetica-Bold*, *Helvetica-BoldOblique*, *Courier*,
97+
*Courier-Oblique*, *Courier-Bold*, *Courier-BoldOblique*
98+
.
9699
The default is Helvetica.
97100

98101
**fontsize** *font size*
@@ -101,8 +104,9 @@ The size of the PostScript font (in 1/72nds of an inch). The default is
101104

102105
**color** *name*
103106
The following colors names are accepted by *ps.map*:
104-
` aqua, black, blue, brown, cyan, gray, grey, green, indigo, magenta, orange, purple, red, violet, white, yellow `.
105-
107+
*aqua*, *black*, *blue*, *brown*, *cyan*, *gray*, *grey*, *green*,
108+
*indigo*, *magenta*, *orange*, *purple*, *red*, *violet*, *white*, *yellow*.
109+
106110
For vectors and some plotting commands you can also specify '`none`' or
107111
'`R:G:B`' (e.g '`255:0:0`').
108112

raster/r.cost/r.cost.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ also considered.
7676
Knight's move example:
7777

7878
![Flat cost surface without and with the knight's move](rcost_knightsmove.png)
79-
*Flat cost surface without (left pane) and with the knight's move (right pane). The default is to grow the cost outwards in 8 directions. Using the knight's move grows it outwards in 16 directions.*
79+
*Flat cost surface without (left pane) and with the knight's move (right pane).
80+
The default is to grow the cost outwards in 8 directions.
81+
Using the knight's move grows it outwards in 16 directions.*
8082

8183
If the **nearest** output parameter is specified, the module will
8284
calculate for each cell its nearest starting point based on the
@@ -93,7 +95,9 @@ option to help the algorithm pick a particular direction.
9395
Example for solving multiple directions:
9496

9597
![A field of equal cumulative costs with multiple paths](rcost_solvedir.png)
96-
*A field of equal cumulative costs with multiple paths (black). By default a path along the edge will be selected (red). Path selection can be controlled with the solver option (blue).*
98+
*A field of equal cumulative costs with multiple paths (black).
99+
By default a path along the edge will be selected (red).
100+
Path selection can be controlled with the solver option (blue).*
97101

98102
Multiple directions can be solved as in the above example with the
99103
following steps:

raster/r.terraflow/r.terraflow.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -165,16 +165,16 @@ r.terraflow elev=elevation.10m filled=elevation10m.filled \
165165

166166
## REFERENCES
167167

168-
1. The [TerraFlow](http://www.cs.duke.edu/geo*/terraflow/) project at Duke University
169-
2. [I/O-efficient algorithms for problems on grid-based
170-
terrains](http://www.cs.duke.edu/geo*/terraflow/papers/alenex00_drainage.ps.gz). Lars Arge, Laura Toma, and Jeffrey S. Vitter. In
168+
1. [I/O-efficient algorithms for problems on grid-based terrains](https://dl.acm.org/doi/10.1145/945394.945395).
169+
Lars Arge, Laura Toma, and Jeffrey S. Vitter. In
171170
*Proc. Workshop on Algorithm Engineering and Experimentation*, 2000.
172171
To appear in *Journal of Experimental Algorithms*.
173-
3. [Flow computation on massive grids](http://www.cs.duke.edu/geo*/terraflow/papers/acmgis01_terraflow.pdf). Lars
174-
Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura Toma, Jeffrey S.
172+
2. [Flow computation on massive grids](https://dl.acm.org/doi/10.1145/512161.512180).
173+
Lars Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura Toma, Jeffrey S.
175174
Vitter, Dean Urban and Rajiv Wickremesinghe. In *Proc. ACM Symposium
176175
on Advances in Geographic Information Systems*, 2001.
177-
4. [Flow computation on massive grid terrains](http://www.cs.duke.edu/geo*/terraflow/papers/journal_terraflow.pdf). Lars Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura
176+
3. [Flow computation on massive grid terrain datasets](https://link.springer.com/article/10.1023/A:1025526421410).
177+
Lars Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura
178178
Toma, Jeffrey S. Vitter, Dean Urban and Rajiv Wickremesinghe. In
179179
*GeoInformatica, International Journal on Advances of Computer
180180
Science for Geographic Information Systems*, 7(4):283-313, December

scripts/r.fillnulls/r.fillnulls.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ The width of edge area can be adjusted by changing the edge parameter.
1818
During the interpolation following warning may occur when using the RST
1919
method:
2020

21-
`Warning: strip exists with insufficient data`
22-
`Warning: taking too long to find points for interpolation--please change the region to area where your points are`
21+
```text
22+
Warning: strip exists with insufficient data
23+
Warning: taking too long to find points for interpolation --please change the region to area where your points are
24+
```
2325

2426
This warning is generated if large data holes exist within the surface.
2527
As the idea of *r.fillnulls* is to fill such holes, the user may ignore

scripts/v.db.reconnect.all/v.db.reconnect.all.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ the vector maps use **-d** flag. Note that attribute tables will be
8383
deleted *permanently* from the source database. This option should be
8484
used very carefully!
8585

86-
### Convert GRASS 6 vector map to GRASS 7 including attribute transfer from DBF to SQLite
86+
### Convert GRASS 6 vector map to GRASS 7
8787

8888
To become usable in GRASS 7, all vector maps in a mapset need to be
8989
updated:

vector/v.clean/v.clean.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ deleting boundaries.
113113
Threshold does not apply (it is ignored), use an arbitrary value (e.g.,
114114
0) if *v.clean* is run with several tools.
115115

116-
### Break (topologically clean) areas (imported from a non topological format like ShapeFile)
116+
### Break (topologically clean) areas (imported from a non topological format)
117117

118118
Setting *tool=bpol* breaks boundaries on each point shared between 2 and
119119
more areas where angles of boundary segments are different and on all

vector/v.label/v.label.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,9 @@ This selects the text color. If unspecified, the label's text is drawn
8080
in *black*, by default. The text color can be specified in one of
8181
several ways:
8282

83-
1. By color name:
84-
`aqua black blue brown cyan gray green grey indigo magenta orange purple red violet white yellow`
83+
1. By color name: *aqua*, *black*, *blue*, *brown*, *cyan*, *gray*,
84+
*green*, *grey*, *indigo*, *magenta*, *orange*, *purple*, *red*,
85+
*violet*, *white*, *yellow*
8586
2. As red, green, blue component values. (0-255)
8687
for example: `128:100:200`
8788
3. Specify "`none`" to suppress the lettering.

vector/v.qcount/v.qcount.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ There are two types departure from a CSR: regularity and clustering.
1010
Figure 1 gives an example of a complete random, regular and a clustered
1111
pattern.
1212

13-
![complete spatial randomness](v_qcount_1.png) ![regularity](v_qcount_2.png) ![clustering](v_qcount_3.png)
13+
![complete spatial randomness](v_qcount_1.png)
14+
![regularity](v_qcount_2.png)
15+
![clustering](v_qcount_3.png)
1416
*Figure 1: Realization of two-dimensional Poisson processes of 50 points
1517
on the unit square exhibiting (a) complete spatial randomness, (b)
1618
regularity, and (c) clustering.*

vector/v.segment/v.segment.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,10 @@ d.vect map=myrailroads display=shape,dir
164164
d.vect map=myrailroads_pt10pctO500m icon=basic/circle color=red fcolor=black size=5
165165
```
166166

167-
![A series of points, spaced every 10% of the line's length along the tracks from the end of the line up to the middle point, offset 500m to the right](v_segment_spaced_percent_points.jpg)
168-
*A series of points, spaced every 10% of the line's length along the tracks from the end of the line up to the middle point, offset 500m to the right*
167+
![A series of points, spaced every 10% of the line's length along the tracks
168+
from the end of the line up to the middle point, offset 500m to the right](v_segment_spaced_percent_points.jpg)
169+
*A series of points, spaced every 10% of the line's length along the tracks
170+
from the end of the line up to the middle point, offset 500m to the right*
169171

170172
## KNOWN ISSUES
171173

0 commit comments

Comments
 (0)