Code Monkey home page Code Monkey logo

Comments (5)

bell07 avatar bell07 commented on July 18, 2024

I know and like the doc_items mod. You get a great work for this!
Unfortunately I am quite uninspired for or so pull request with your descriptions welcome!

from qa_block.

Wuzzy2 avatar Wuzzy2 commented on July 18, 2024

I'm not sure if I can trust myself in writing a complete help text for the block myself because I am not sure if I understood the mod 100%, to be honest. xD

from qa_block.

bell07 avatar bell07 commented on July 18, 2024

Ok, I wrote some words: 7cb996a
Please check if my english is enough. If something is not understandable you can ask in german

from qa_block.

Wuzzy2 avatar Wuzzy2 commented on July 18, 2024

Thanks a bunch! You mod has been added to the list of mods supporting the Help modpack.

Here is the rewritten text for you:

local doc_items_longdesc =
[[The QA block is a quality assurance tool for mod and subgame developers.
By using the block it is possible to:
• Browse trough global Lua variables for deeper insight
• Execute ad-hoc Lua code for testing reasons in development
• Run predefined checks for quality assurance
]]

local doc_items_usagehelp =
[[Place the block and open the formspec using right mouse click.
Use the “Globals” tab for browsing trough global Lua variables.
Use the “Checks” tab to run Lua code. Editing the code before running is allowed.
The checks are read from the $MODPATH/checks directory.
It is possible to add new Lua files and run them without restarting the game. Just use the Refresh button.
Ususally the print() command is used in checks, so look in debug.txt or the Minetest console output.
Some chat commands are defined as shortcuts. See “/qa help” for more information.
Please note the “/qa ui” cannot store the current globals navigation, the navigation can be stored in the QA block only.
]]

Notes:

  • Please remember to check your punctuation.
  • It's “Lua”, not “lua”
  • The Help modpack does line breaks automatically for you :-)

EDIT: Also please don't forget to keep the help up-to date as you add more features to the block.

from qa_block.

bell07 avatar bell07 commented on July 18, 2024

Done. Thank you for the review. Updated..
Up-to-date docu grrr, developers nightmare ><

from qa_block.

Related Issues (10)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.