Skip to content

Commit

Permalink
docs: fix line-length (#5174)
Browse files Browse the repository at this point in the history
  • Loading branch information
petrasovaa authored Feb 25, 2025
1 parent 3c3e286 commit 429a884
Show file tree
Hide file tree
Showing 20 changed files with 134 additions and 71 deletions.
4 changes: 3 additions & 1 deletion .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ fix: true
MD041: false # first-line-h1

# Errors from .html to .md rename (first step in HTML to Markdown conversion)
line-length: false
MD013:
code_blocks: false
tables: false
# The block above this is to be eventually removed.
3 changes: 1 addition & 2 deletions db/drivers/postgres/grass-pg.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,7 @@ v.info -t test
#### Geometry Converters
- [PostGIS with
shp2pgsql](https://postgis.net/workshops/postgis-intro/loading_data.html#loading-with-shp2pgsql):
- [PostGIS with shp2pgsql](https://postgis.net/workshops/postgis-intro/loading_data.html#loading-with-shp2pgsql):
`shp2pgsql -D lakespy2 lakespy2 test > lakespy2.sql`
- [e00pg](https://e00pg.sourceforge.net/): E00 to PostGIS filter, see
also *[v.in.e00](v.in.e00.md)*.
Expand Down
18 changes: 9 additions & 9 deletions general/g.proj/g.proj.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ proprietary GIS. In addition, if one of the parameters *georef*, *wkt*,
project, the CRS information is imported from an external source as
follows:

- With **georef**=*filename* g.proj attempts to invoke GDAL and OGR in turn to read a georeferenced
file *filename*. The CRS information will be read from this file. If the
file is not georeferenced or cannot be read, XY (unprojected) will be
used.

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

- When using **wkt**=*filename*, the file *filename* should contain a CRS
description in WKT format with or without line-breaks (e.g. a '.prj' file).
If **-** is given for the filename, the WKT description will be read from
stdin rather than a file.

- **proj4**=*description* should be a CRS description in [PROJ](https://proj.org/)
format, enclosed in quotation marks if there are any spaces. If **-** is
Expand Down
16 changes: 8 additions & 8 deletions general/g.region/g.region.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ always updated unless **-u** was specified.

### Additional parameter information

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

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

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

## EXAMPLES
Expand Down
6 changes: 4 additions & 2 deletions imagery/i.gensig/i.gensig.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ member of the imagery group. Signatures generated for one scene are
suitable for classification of other scenes as long as they consist of
same raster bands (semantic labels match).

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

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

## NOTES
Expand Down
11 changes: 6 additions & 5 deletions imagery/i.gensigset/i.gensigset.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ An usage example can be found in [i.smap](i.smap.md) documentation.

### Parameters

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

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

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

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

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

The spectral signatures which are produced by this program are "mixed"
signatures (see [NOTES](#notes)). Each signature contains one or more
Expand Down
6 changes: 4 additions & 2 deletions imagery/i.maxlik/i.maxlik.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,10 @@ r.mapcalc "lsat7_2002_cluster_classes_filtered = \
![Output raster map with pixels classified (10 classes)](i_maxlik_classes.png)
*Output raster map with pixels classified (10 classes)*

![Output raster map with rejection probability values (pixel classification confidence levels)](i_maxlik_rejection.png)
*Output raster map with rejection probability values (pixel classification confidence levels)*
![Output raster map with rejection probability values
(pixel classification confidence levels)](i_maxlik_rejection.png)
*Output raster map with rejection probability values
(pixel classification confidence levels)*

## SEE ALSO

Expand Down
6 changes: 5 additions & 1 deletion imagery/i.segment/i.segment.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ the distance calculation will also take into account the shape
characteristics of the segments. The normal distances are then
multiplied by the input radiometric weight. Next an additional
contribution is added:
`(1-radioweight) * {smoothness * smoothness weight + compactness * (1-smoothness weight)}`,

```text
(1-radioweight) * {smoothness * smoothness weight + compactness * (1-smoothness weight)}
```

where `compactness = Perimeter Length / sqrt( Area )` and
`smoothness = Perimeter Length / Bounding Box`. The perimeter length is
estimated as the number of pixel sides the segment has.
Expand Down
69 changes: 51 additions & 18 deletions lib/init/grass.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,50 +243,83 @@ HTML web browser to use for displaying help pages.

The following are some examples of how you could start GRASS

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

**grass --gui**
```sh
grass
```

Start GRASS using the graphical user interface. The user will be
prompted to choose the appropriate project and mapset.

**grass --text**
```sh
grass --gui
```

Start GRASS using the text-based user interface. Appropriate project and
mapset must be set by environmental variables (see examples below)
otherwise taken from the last GRASS session.

**grass --gtext**
```sh
grass --text
```

Start GRASS using the text-based user interface. The user will be
prompted to choose the appropriate project and mapset.

**grass $HOME/grassdata/spearfish70/user1**
```sh
grass --gtext
```

Start GRASS using the default user interface and automatically launch
into the given mapset, bypassing the mapset selection menu.
into the given mapset, bypassing the mapset selection menu:

```sh
grass $HOME/grassdata/spearfish70/user1
```

**grass --gui -**
Start GRASS using the graphical user interface and try to obtain the
project and mapset from environment variables.
project and mapset from environment variables:

```sh
grass --gui -
```

**grass -c EPSG:4326 $HOME/grassdata/myproject**
Creates a new GRASS project with EPSG code 4326 (latitude-longitude,
WGS84) in the specified GISDBASE
WGS84) in the specified GISDBASE:

```sh
grass -c EPSG:4326 $HOME/grassdata/myproject
```

**grass -c EPSG:5514:3 $HOME/grassdata/myproject**
Creates a new GRASS project with EPSG code 5514 (S-JTSK / Krovak East
North - SJTSK) with datum transformation parameters used in Czech
Republic in the specified GISDBASE
Republic in the specified GISDBASE:

```sh
grass -c EPSG:5514:3 $HOME/grassdata/myproject
```

**grass -c XY $HOME/grassdata/gnomonic --exec g.proj -c proj4='+proj=gnom +lat_0=90 +lon_0=-50'**
Creates a new GRASS project from PROJ definition string (here:
[gnomonic](https://proj4.org/operations/projections/gnom.html)) in the
specified GISDBASE
specified GISDBASE:

```sh
grass -c XY $HOME/grassdata/gnomonic --exec g.proj -c proj4='+proj=gnom +lat_0=90 +lon_0=-50'
```

Creates a new GRASS project based on georeferenced Shapefile:

```sh
grass -c myvector.shp $HOME/grassdata/myproject
```

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

**grass -c myraster.tif $HOME/grassdata/myproject**
Creates a new GRASS project based on georeferenced GeoTIFF file
```sh
grass -c myraster.tif $HOME/grassdata/myproject
```

### Batch jobs with the exec interface

Expand Down
10 changes: 7 additions & 3 deletions ps/ps.map/ps.map.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ zero, the default vertical location is used.
**font** *font name*
The name of the PostScript font. Fonts present in all PostScript
implementations are:
`Times-Roman, Times-Italic, Times-Bold, Times-BoldItalic, Helvetica, Helvetica-Oblique, Helvetica-Bold, Helvetica-BoldOblique, Courier, Courier-Oblique, Courier-Bold, and Courier-BoldOblique`.
*Times-Roman*, *Times-Italic*, *Times-Bold*, *Times-BoldItalic*, *Helvetica*,
*Helvetica-Oblique*, *Helvetica-Bold*, *Helvetica-BoldOblique*, *Courier*,
*Courier-Oblique*, *Courier-Bold*, *Courier-BoldOblique*
.
The default is Helvetica.

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

**color** *name*
The following colors names are accepted by *ps.map*:
` aqua, black, blue, brown, cyan, gray, grey, green, indigo, magenta, orange, purple, red, violet, white, yellow `.

*aqua*, *black*, *blue*, *brown*, *cyan*, *gray*, *grey*, *green*,
*indigo*, *magenta*, *orange*, *purple*, *red*, *violet*, *white*, *yellow*.

For vectors and some plotting commands you can also specify '`none`' or
'`R:G:B`' (e.g '`255:0:0`').

Expand Down
8 changes: 6 additions & 2 deletions raster/r.cost/r.cost.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ also considered.
Knight's move example:

![Flat cost surface without and with the knight's move](rcost_knightsmove.png)
*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.*
*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.*

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

![A field of equal cumulative costs with multiple paths](rcost_solvedir.png)
*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).*
*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).*

Multiple directions can be solved as in the above example with the
following steps:
Expand Down
12 changes: 6 additions & 6 deletions raster/r.terraflow/r.terraflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,16 +165,16 @@ r.terraflow elev=elevation.10m filled=elevation10m.filled \

## REFERENCES

1. The [TerraFlow](http://www.cs.duke.edu/geo*/terraflow/) project at Duke University
2. [I/O-efficient algorithms for problems on grid-based
terrains](http://www.cs.duke.edu/geo*/terraflow/papers/alenex00_drainage.ps.gz). Lars Arge, Laura Toma, and Jeffrey S. Vitter. In
1. [I/O-efficient algorithms for problems on grid-based terrains](https://dl.acm.org/doi/10.1145/945394.945395).
Lars Arge, Laura Toma, and Jeffrey S. Vitter. In
*Proc. Workshop on Algorithm Engineering and Experimentation*, 2000.
To appear in *Journal of Experimental Algorithms*.
3. [Flow computation on massive grids](http://www.cs.duke.edu/geo*/terraflow/papers/acmgis01_terraflow.pdf). Lars
Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura Toma, Jeffrey S.
2. [Flow computation on massive grids](https://dl.acm.org/doi/10.1145/512161.512180).
Lars Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura Toma, Jeffrey S.
Vitter, Dean Urban and Rajiv Wickremesinghe. In *Proc. ACM Symposium
on Advances in Geographic Information Systems*, 2001.
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
3. [Flow computation on massive grid terrain datasets](https://link.springer.com/article/10.1023/A:1025526421410).
Lars Arge, Jeffrey S. Chase, Patrick N. Halpin, Laura
Toma, Jeffrey S. Vitter, Dean Urban and Rajiv Wickremesinghe. In
*GeoInformatica, International Journal on Advances of Computer
Science for Geographic Information Systems*, 7(4):283-313, December
Expand Down
6 changes: 4 additions & 2 deletions scripts/r.fillnulls/r.fillnulls.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ The width of edge area can be adjusted by changing the edge parameter.
During the interpolation following warning may occur when using the RST
method:

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

This warning is generated if large data holes exist within the surface.
As the idea of *r.fillnulls* is to fill such holes, the user may ignore
Expand Down
2 changes: 1 addition & 1 deletion scripts/v.db.reconnect.all/v.db.reconnect.all.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ the vector maps use **-d** flag. Note that attribute tables will be
deleted *permanently* from the source database. This option should be
used very carefully!

### Convert GRASS 6 vector map to GRASS 7 including attribute transfer from DBF to SQLite
### Convert GRASS 6 vector map to GRASS 7

To become usable in GRASS 7, all vector maps in a mapset need to be
updated:
Expand Down
2 changes: 1 addition & 1 deletion vector/v.clean/v.clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ deleting boundaries.
Threshold does not apply (it is ignored), use an arbitrary value (e.g.,
0) if *v.clean* is run with several tools.

### Break (topologically clean) areas (imported from a non topological format like ShapeFile)
### Break (topologically clean) areas (imported from a non topological format)

Setting *tool=bpol* breaks boundaries on each point shared between 2 and
more areas where angles of boundary segments are different and on all
Expand Down
5 changes: 3 additions & 2 deletions vector/v.label/v.label.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@ This selects the text color. If unspecified, the label's text is drawn
in *black*, by default. The text color can be specified in one of
several ways:

1. By color name:
`aqua black blue brown cyan gray green grey indigo magenta orange purple red violet white yellow`
1. By color name: *aqua*, *black*, *blue*, *brown*, *cyan*, *gray*,
*green*, *grey*, *indigo*, *magenta*, *orange*, *purple*, *red*,
*violet*, *white*, *yellow*
2. As red, green, blue component values. (0-255)
for example: `128:100:200`
3. Specify "`none`" to suppress the lettering.
Expand Down
4 changes: 3 additions & 1 deletion vector/v.qcount/v.qcount.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ There are two types departure from a CSR: regularity and clustering.
Figure 1 gives an example of a complete random, regular and a clustered
pattern.

![complete spatial randomness](v_qcount_1.png) ![regularity](v_qcount_2.png) ![clustering](v_qcount_3.png)
![complete spatial randomness](v_qcount_1.png)
![regularity](v_qcount_2.png)
![clustering](v_qcount_3.png)
*Figure 1: Realization of two-dimensional Poisson processes of 50 points
on the unit square exhibiting (a) complete spatial randomness, (b)
regularity, and (c) clustering.*
Expand Down
6 changes: 4 additions & 2 deletions vector/v.segment/v.segment.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,10 @@ d.vect map=myrailroads display=shape,dir
d.vect map=myrailroads_pt10pctO500m icon=basic/circle color=red fcolor=black size=5
```

![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)
*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*
![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)
*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*

## KNOWN ISSUES

Expand Down
Loading

0 comments on commit 429a884

Please sign in to comment.