Add dirt node group documentation #142

erlehmann · 2021-09-08T03:23:57+02:00

erlehmann commented

2021-09-08 03:23:57 +02:00

Problem

TRACKING ISSUE: #141

Several node are part of a group called dirt with a value of 1, 2, or 3.

The meaning of this parameter is not yet documented in GROUPS.md.

Solution

This patch adds the following text to GROUPS.md:

* `dirt=1`: Uncovered dirt
* `dirt=2`: Covered dirt (grass or mycelium or podzol on top)
* `dirt=3`: Coarse dirt

Details

I totally guessed what the dirt node group number actually means.

Testing Steps

Verify Bug

On Mineclonia commit 42a076cc0b, execute:

git grep -W 'dirt\s*=\s*[0-9]' mods: Verify that the following nodes are assigned the listed dirt group:
- mcl_core:dirt: dirt=1
- mcl_core:dirt_with_grass: dirt=2
- mcl_core:mycelium: dirt=2
- mcl_core:podzol: dirt=2
- mcl_core:coarse_dirt: dirt=3
git grep 'dirt\s*=' GROUPS.md: Verify that it outputs nothing.

Verify Patch

On Mineclonia commit e1462d9534, execute:

git grep -W 'dirt\s*=\s*[0-9]' mods: Verify that the following nodes are assigned the listed dirt group:
- mcl_core:dirt: dirt=1
- mcl_core:dirt_with_grass: dirt=2
- mcl_core:mycelium: dirt=2
- mcl_core:podzol: dirt=2
- mcl_core:coarse_dirt: dirt=3
git grep 'dirt\s*=' GROUPS.md: Verify that it outputs the following:

GROUPS.md:* `dirt=1`: Uncovered dirt
GROUPS.md:* `dirt=2`: Covered dirt (grass or mycelium or podzol on top)
GROUPS.md:* `dirt=3`: Coarse dirt

To do

Fill out issue template
Write testing steps
Verify test plan

##### Problem TRACKING ISSUE: https://git.minetest.land/Mineclonia/Mineclonia/issues/141 Several node are part of a group called dirt with a value of 1, 2, or 3. The meaning of this parameter is not yet documented in GROUPS.md. ##### Solution This patch adds the following text to GROUPS.md: ``` * `dirt=1`: Uncovered dirt * `dirt=2`: Covered dirt (grass or mycelium or podzol on top) * `dirt=3`: Coarse dirt ``` ##### Details I totally guessed what the dirt node group number actually means. ##### Testing Steps ###### Verify Bug On Mineclonia commit 42a076cc0b1df7a7d9d2269e82f67ff86d0c0e33, execute: 1. `git grep -W 'dirt\s*=\s*[0-9]' mods`: Verify that the following nodes are assigned the listed dirt group: * `mcl_core:dirt`: dirt=1 * `mcl_core:dirt_with_grass`: dirt=2 * `mcl_core:mycelium`: dirt=2 * `mcl_core:podzol`: dirt=2 * `mcl_core:coarse_dirt`: dirt=3 2. `git grep 'dirt\s*=' GROUPS.md`: Verify that it outputs nothing. ###### Verify Patch On Mineclonia commit e1462d953451ae7764d13d4ce01667b03d0b82da, execute: 1. `git grep -W 'dirt\s*=\s*[0-9]' mods`: Verify that the following nodes are assigned the listed dirt group: * `mcl_core:dirt`: dirt=1 * `mcl_core:dirt_with_grass`: dirt=2 * `mcl_core:mycelium`: dirt=2 * `mcl_core:podzol`: dirt=2 * `mcl_core:coarse_dirt`: dirt=3 2. `git grep 'dirt\s*=' GROUPS.md`: Verify that it outputs the following: ``` GROUPS.md:* `dirt=1`: Uncovered dirt GROUPS.md:* `dirt=2`: Covered dirt (grass or mycelium or podzol on top) GROUPS.md:* `dirt=3`: Coarse dirt ``` ##### To do - [x] Fill out issue template - [x] Write testing steps - [x] Verify test plan

erlehmann added 1 commit 2021-09-08 03:23:58 +02:00

e1462d9534

Add dirt node group documentation

cora approved these changes 2021-09-08 03:39:17 +02:00

cora left a comment

Verify bug

1. git grep -W 'dirt\s*=\s*[0-9]' mods: Verify that the following nodes are assigned the listed dirt group:
[...]
2. git grep 'dirt\s*=' GROUPS.md: Verify that it outputs nothing.

Verify Patch

On Mineclonia commit e1462d9534, execute:

1. git grep -W 'dirt\s*=\s*[0-9]' mods: Verify that the following nodes are assigned the listed dirt group:
[...]
2. git grep 'dirt\s*=' GROUPS.md: Verify that it outputs the following:
[...]

###### Verify bug - [x] 1. `git grep -W 'dirt\s*=\s*[0-9]' mods`: Verify that the following nodes are assigned the listed dirt group: [...] - [x] 2. `git grep 'dirt\s*=' GROUPS.md`: Verify that it outputs nothing. ###### Verify Patch On Mineclonia commit e1462d953451ae7764d13d4ce01667b03d0b82da, execute: - [x] 1. `git grep -W 'dirt\s*=\s*[0-9]' mods`: Verify that the following nodes are assigned the listed dirt group: [...] - [x] 2. `git grep 'dirt\s*=' GROUPS.md`: Verify that it outputs the following: [...]

cora merged commit 07a59ef120 into master

2021-09-08 03:39:32 +02:00

cora referenced this issue from a commit

2021-09-08 03:39:33 +02:00

Merge pull request 'Add dirt node group documentation' (#142) from add-dirt-group-documentation into master

cora deleted branch add-dirt-group-documentation

2021-09-08 03:39:34 +02:00

cora referenced this pull request

2021-09-08 03:39:54 +02:00

Dirt node group is not documented #141

This repo is archived. You cannot comment on pull requests.

No reviewers