mt-mods / mt-mods/pipeworks

No documentation on the 'tags' feature

Open
#186 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
20
Forks
31
Avg merge
1m
Merged PRs (30d)
9

Description

I am currently trying to review https://github.com/minetest-mods/drawers/pull/102 but at the time of writing, there is simply a TODO about 'tags' on https://github.com/mt-mods/pipeworks/wiki . Surely, code may does answer some questions - but it also paves the way to relying on (potentially) unsupported or unintended behaviour.

Questions that the documentation should answer:

  1. What is the goal of that feature?
  2. How do you set it up? Which nodes can make use of it?
  3. What are the relevant API functions?
  4. Is there only msg.tag or also msg.tags? If there's both - which does take precedence?
  5. What are the expected data formats of those functions?

Thank you.

EDIT: A rough documentation exists in https://github.com/mt-mods/pipeworks/pull/107#issuecomment-1925943467 - but that's not where a modder should (or rather would) look for it.

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

Start with the TODO on the Pipeworks wiki and the rough documentation in the comment on pull request #107. Verify that the documentation answers the five listed questions, including setup, supported nodes, API functions, tag precedence, and data formats. Done means the information is available where modders would normally look rather than only in a pull-request comment.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.