Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix code blocks language #1359

Merged
merged 3 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/display/d.explanation.plot/d.explanation.plot.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ r.series input=a,b,c output=d method=average

In Python:

```sh
```python
import grass.jupyter as gj
plot = gj.Map(use_region=True, width=700, height=700)
plot.d_background(color="white")
Expand Down
38 changes: 19 additions & 19 deletions src/general/g.projpicker/g.projpicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ query syntax is case-sensitive.
Various coordinate formats are supported. For the *latlon* coordinate
system, the following points are all identical:

```sh
```text
################################
# decimal degrees and separators
################################
Expand Down Expand Up @@ -66,7 +66,7 @@ system, the following points are all identical:
Any geometries following the *xy* keyword are in the *xy* coordinate
system in an unknown unit. For example,

```sh
```text
xy
396255,1374239
396255 1374239
Expand Down Expand Up @@ -114,7 +114,7 @@ of a bounding box.

See the following example:

```sh
```text
# point geometry
# starts in latlon
point
Expand Down Expand Up @@ -150,7 +150,7 @@ xy

The above **input** file is parsed to:

```sh
```python
['point',
[10.0, 20.0],
'xy',
Expand Down Expand Up @@ -183,7 +183,7 @@ must be given as the first word.
This query string performs the AND of all geometries A, B, C, and D, and
returns projections that completely contain all of them:

```sh
```text
and
# A, B, C, or D can be point, poly, or bbox individually
A
Expand All @@ -195,7 +195,7 @@ D
This query string performs the OR of all geometries and returns
projections that completely contain any of them:

```sh
```text
or
# A, B, C, or D can be point, poly, or bbox individually
A
Expand All @@ -207,7 +207,7 @@ D
This query string performs the XOR of two geometries and returns
projections that completely contain only one of them:

```sh
```text
xor
# A or B can be point, poly, or bbox individually
A
Expand All @@ -219,7 +219,7 @@ more than two geometries does not return mutually exclusive projections.
For example, this query string returns projections that contain only A,
B, or C exclusively, and additionally all three geometries:

```sh
```text
xor
# A, B, or C can be point, poly, or bbox individually
A
Expand All @@ -235,7 +235,7 @@ If the first word is *prefix* in the query string, *and*, *or*, *xor*,
This query string returns all projections that completely contain
geometry A, but not B:

```sh
```text
postfix
A # find A
B # find B
Expand All @@ -246,7 +246,7 @@ and # A and not B
This query string returns all projections that contain A or B, but not
C: A, but not B:

```sh
```text
postfix
A # find A
B # find B
Expand All @@ -259,7 +259,7 @@ and # (A or B) and not C
This query string returns all projections that contain both A and B, but
not C; or those that contain C, but neither A nor B:

```sh
```text
postfix
A # find A
B # find B
Expand All @@ -271,7 +271,7 @@ xor # (A and B) xor C
This query string returns all projections that contain only one of A, B,
or C exclusively:

```sh
```text
postfix
A # find A
B # find B
Expand All @@ -295,7 +295,7 @@ geometries are useful to manipulate existing projection sets.
This query string ignores all results above *none* and returns those
projections that only contain X:

```sh
```text
postfix
A # find A
B # find B
Expand All @@ -311,7 +311,7 @@ or # empty or X = X

This query string returns all projections not in degree that contain A:

```sh
```text
postfix
A # find A
unit=degree # restrict queries to degree unit
Expand All @@ -332,7 +332,7 @@ This query string returns all projections in *xy* that contain A that
can be transformed to B in EPSG:4326 within a *match\_tol* distance
tolerance in *xy* (default 1):

```sh
```text
postfix
match_tol=200 # error tolerance in an xy unit for distance matching
A # known coordinates in an unknown projection and unit
Expand All @@ -346,7 +346,7 @@ module and is slow because it has to transform B to many projections
that contain both A and B. To save time and just return the first match,
use *match\_max* (default 0 for all):

```sh
```text
postfix
match_tol=200 # error tolerance in an xy unit for distance matching
match_max=1 # return the first match only and quit
Expand All @@ -369,7 +369,7 @@ stored and used immediately.

See the following example:

```sh
```text
postfix
# define city geometries, but not used immediately
city_A:
Expand Down Expand Up @@ -404,7 +404,7 @@ quotes unless they are separated by whitespaces.

See the following example:

```sh
```text
point 10,20 xy 3,4
# use a space-comma-space to start a new poly
latlon poly 10,20 "30 40" xy 5,6 7,8 9,10 , 11,12 13,14
Expand All @@ -415,7 +415,7 @@ latlon bbox 10,20,30,40 xy 5,6,7,8

The output schema for the *sqlite* **format** is as follows:

```sh
```sql
CREATE TABLE bbox (
proj_table TEXT NOT NULL CHECK (length(proj_table) >= 1),
crs_name TEXT NOT NULL CHECK (length(crs_name) >= 2),
Expand Down
2 changes: 1 addition & 1 deletion src/general/g.rename.many/g.rename.many.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ delimiter comma and no text delimiter) or as a text file in any (plain)
text editor. In any case, the result should be a plain text file with
format and content similar to the following sample:

```sh
```csv
landuse96_28m,landuse
geology_30m,geology
soilsID,soils
Expand Down
2 changes: 1 addition & 1 deletion src/imagery/i.eodag/i.eodag.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ including:
Following is an example for a config YAML file with Copernicus Dataspace
credentials:

```sh
```yaml
cop_dataspace:
priority: # Lower value means lower priority (Default: 0)
search: # Search parameters configuration
Expand Down
4 changes: 2 additions & 2 deletions src/imagery/i.feotio2/i.feotio2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Clementine UVVIS sensor has five bands, UVVIS1 = 415, UVVIS2 = 750,
UVVIS3 = 900, UVVIS4 = 950 and UVVIS5 = 1000 nm.

```sh
```text
wt%TiO2 = 3.708 arctan ((R415/R750)-y0Ti)/(R750-s0Ti) (1)

wt%FeO = -137.97 ( R750 sin(theta) + (R950/R750) cos(theta) ) + 57.46 (2)
Expand All @@ -15,7 +15,7 @@ from Wilcox et al (2005). [Map-a-Planet
Explorer](https://web.archive.org/web/20161203071556/http://www.mapaplanet.org/explorer/help/index.html)
mentions this set of equations:

```sh
```c
double feolucey2000(double uvvis2, double uvvis4){
//\cite{lucey2000lunar}
return(17.427*(-atan2f(((uvvis4/uvvis2)-1.19)/(uvvis2-0.08)))-7.565);
Expand Down
6 changes: 3 additions & 3 deletions src/imagery/i.fusion.hpf/i.fusion.hpf.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ deviation of the original multi-spectral image.
5. Optionally, matching histogram of Pansharpened image to the one of
the original MSX image

```sh
```text
Figure:
____________________________________________________________________________
+ +
Expand Down Expand Up @@ -84,11 +84,11 @@ i.colors.enhance b=lsat7_2000_10_hpf g=lsat7_2000_20_hpf r=lsat7_2000_30_hpf
d.rgb b=lsat7_2000_10_hpf g=lsat7_2000_20_hpf r=lsat7_2000_30_hpf
```

[![image-alt](i_fusion_hpf_lsat7_orig_rgb.png)](i_fusion_hpf_lsat7_orig_rgb.png)
![image-alt](i_fusion_hpf_lsat7_orig_rgb.png)
*Figure: Original Landsat 7 RGB color composite at 28.5m resolution
(North Carolina, Raleigh subset)*

[![image-alt](i_fusion_hpf_lsat7_hpf_rgb.png)](i_fusion_hpf_lsat7_hpf_rgb.png)
![image-alt](i_fusion_hpf_lsat7_hpf_rgb.png)
*Figure: Pansharpened Landsat 7 RGB color composite at 14.25m
resolution(North Carolina, Raleigh subset)*

Expand Down
2 changes: 1 addition & 1 deletion src/imagery/i.gabor/i.gabor.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ greater than or equal to the percentile value. Where a bit string
position is equal to one it indicates the corresponding
orientation*<sub>i</sub>* has a strong response.

```sh
```text
orientation = 0, 45, 90, 135
0 = 0b00000001 = 1
45 = 0b00000010 = 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,14 @@ signing up.

USGS settings file:

```sh
```text
myusername
mypassword
```

USGS interactive settings:

```sh
```text
Insert username: myusername
Insert password:
```
Expand Down
2 changes: 1 addition & 1 deletion src/imagery/i.landsat8.swlst/i.landsat8.swlst.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ At-satellite brightness temperatures are derived from the TIRS channels
their quantized digital numbers converted to at-satellite temperature
values.

```sh
```text
+--------+ +--------------------------+
|Landsat8+--->Cloud screen & calibration|
+--------+ +---+--------+-------------+
Expand Down
2 changes: 1 addition & 1 deletion src/imagery/i.lswt/i.lswt.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ module uses a simplified non-linear split-window algorithm.

The non-linear split window equation used here is:

```sh
```text
LSWT = Ti + c1 * (Ti - Tj) + c2 * (Ti - Tj) ^ 2 + c0
```

Expand Down
4 changes: 2 additions & 2 deletions src/imagery/i.modis/i.modis.download/i.modis.download.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ways:
[.netrc](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html)
file as showed below:

```sh
```text
machine e4ftl01.cr.usgs.gov
login your_NASA_username
password your_NASA_password
Expand All @@ -42,7 +42,7 @@ ways:
- pass a file in which the first row is the username, and the second
row is the password, as showed below:

```sh
```text
your_NASA_username
your_NASA_password
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ average visible band Digital Number values.

### Overview

```sh
```text
+----------------------------------------------------------------------+
| |
| +-----------------+ |
Expand Down
6 changes: 2 additions & 4 deletions src/imagery/i.sam2/i.sam2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,15 @@ using [SamGeo](https://samgeo.gishub.org/).
- [segment-geospatial\>=0.12.3](https://samgeo.gishub.org/)

```sh
pip install pillow numpy torch segment-geospatial

pip install pillow numpy torch segment-geospatial
```

## EXAMPLES

Segment orthoimagery using SamGeo2:

```sh
i.sam2 group=rgb_255 output=tree_mask text_prompt="trees"

i.sam2 group=rgb_255 output=tree_mask text_prompt="trees"
```

![i.sam2: trees detected in an aerial image with samgeo](i_sam2_trees.jpg)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Copernicus Data Space Ecosystem is now the new successor.
*i.sentinel.download* reads the user credentials from the **settings**
file. The file must contain at least two lines:

```sh
```text
myusername
mypassword
```
Expand All @@ -89,7 +89,7 @@ User credentials can be also defined interactively when **settings=-**
is given. Note that interactive prompt does not work in the graphical
user interface.

```sh
```text
Insert username: myusername
Insert password:
```
Expand Down
4 changes: 2 additions & 2 deletions src/imagery/i.sentinel/i.sentinel.import/i.sentinel.import.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ linked file name as *source2*. Also, sensing time is written into the
timestamp of the map. After import, the metadata can be retrieved with
*r.info -e* as shown below.

```sh
<td>SATELLITE=S2B
```text
SATELLITE=S2B
CLOUDY_PIXEL_PERCENTAGE=1.250696
DEGRADED_MSI_DATA_PERCENTAGE=0
NODATA_PIXEL_PERCENTAGE=58.089572
Expand Down
4 changes: 2 additions & 2 deletions src/imagery/i.sentinel/i.sentinel.mask/i.sentinel.mask.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ must be imported in GRASS and specified one by one or using an input
text file. The text file has to be written following the syntax below:
*variable=your\_map*

```sh
```text
blue=your_blue_map
green=your_green_map
red=your_red_map
Expand Down Expand Up @@ -118,7 +118,7 @@ i.sentinel.mask -r input_file=path/input_cloud_mask.txt cloud_mask=cloud \

The input text file:

```sh
```text
blue=T17SPV_20180315T160021_B02_cor
green=T17SPV_20180315T160021_B03_cor
red=T17SPV_20180315T160021_B04_cor
Expand Down
6 changes: 0 additions & 6 deletions src/imagery/i.spec.sam/i.spec.sam.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ grass \# Matrix: 4 by 6 row0: 8.87 13.14 11.71 35.85 28.26 10.54 row1:
13.59 20.12 19.61 70.66 34.82 16.35 row2: 28.26 34.82 38.27 40.1 38.27
23.7 row3: 10.54 16.35 23.7 38.98 40.1 38.98

## EXAMPLES

```sh
TODO
```

## REFERENCES

- Neteler, M., 1999: Spectral Mixture Analysis von Satellitendaten zur
Expand Down
2 changes: 1 addition & 1 deletion src/imagery/i.spec.unmix/i.spec.unmix.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ or from the PCA analysis.

Sample content of "spectrum.dat":

```sh
```text
# Channels: r g b i1 i2 i3
# Enter spectra linewise!
# 1. Sagebrush
Expand Down
Loading