diff options
author | Wuzzy <almikes@aol.com> | 2016-08-13 13:41:02 +0200 |
---|---|---|
committer | Wuzzy <almikes@aol.com> | 2016-08-13 13:41:02 +0200 |
commit | d7704c2deaa3cd5d05230dbbedc373ded7bf660a (patch) | |
tree | 0e21a11737e8a4ebcbc97200495c6dc00b1e39a5 /API.md | |
parent | d6cecb387c867f14a3a9de793e158c874a974253 (diff) |
Add naming conventions
Diffstat (limited to 'API.md')
-rw-r--r-- | API.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -209,3 +209,13 @@ Returns how many entries have been viewed by a player. #### Return value Amount of entries the player has viewed in the specified category. If the player does not exist, this function returns `nil`. + + +## Extending this mod (naming conventions) +If you want to extend this mod with your own functionality, it is recommended +that you put all API functions into `doc.sub.<name>`. +As a naming convention, if your mod depends on `doc`, your mod name should also start +with “`doc_`”, like `doc_items`, `doc_minetest_game`, `doc_identifier`. + +One mod which uses this convention is `doc_items` which uses the `doc.sub.items` +table. |