OpenTTD / OpenTTD/nml

Document procedures for switches and random switches

Open
#105 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
58
Forks
46
Avg merge
11d 15h
Merged PRs (30d)
3

Description

Procedures were added in https://github.com/OpenTTD/nml/pull/66

NML docs need updated to cover procedures.

Maybe directly in these pages?
https://newgrf-specs.tt-wiki.net/wiki/NML:Switch
https://newgrf-specs.tt-wiki.net/wiki/NML:Random_switch

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the procedures added in pull request 66, then compare the NML:Switch and NML:Random_switch wiki pages linked in the issue. Update the relevant documentation to explain procedures for both switch types, with the pages clearly covering the new functionality when finished.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.