Module:Util/Documentation: Difference between revisions

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
This is the root module for Zelda Wiki's {{Wp|Libarry (computing)|libraries}} or  '''utility functions'''. These are functions that are not directly invoked by any template—they are used only by other modules that share a need for particular subroutines such as [[Module:UtilsArg|parsing template arguments]], [[Module:UtilsTable#sortBy|sorting lists of tables by key]], etc.
This is the root module for Zelda Wiki's {{Wp|Libarry (computing)|libraries}} or  '''utility functions'''. These are functions that are not directly invoked by any template—they are used only by other modules that share a common need for subroutines that can [[Module:UtilsArg|parse template arguments]], [[Module:Util/tables|manipulate tables]], [[Module:Util/strings|compare strings]], and so on.


Each function is located on its own subpage. These are inteded to eventually replace the existing [[:Category:Utility Modules|utility modules]], such as [[Module:UtilsTable]], which cause [[Guidelines:Modules#Performance_Optimization|large job queues]] due to the fact that high-usage functions are bundled together. The hope is that by separating each of these functions into their own submodules, each individual submodule will become highly stable and unlikely to change. Also, new utility functions can be added without triggering any job queue at all.
Each function is located on its own subpage. These are inteded to eventually replace the existing [[:Category:Utility Modules|utility modules]], such as [[Module:UtilsTable]], which cause [[Guidelines:Modules#Performance_Optimization|large job queues]] due to the fact that high-usage functions are packaged together. The hope is that by separating each of these functions into their own module, each individual module will be stable and unlikely to change, and new utility functions can be added without triggering any job queue at all.


[[Category:Utility Modules]]
[[Category:Utility Modules]]

Revision as of 18:04, 11 May 2024

This is the root module for Zelda Wiki's libraries or utility functions. These are functions that are not directly invoked by any template—they are used only by other modules that share a common need for subroutines that can parse template arguments, manipulate tables, compare strings, and so on.

Each function is located on its own subpage. These are inteded to eventually replace the existing utility modules, such as Module:UtilsTable, which cause large job queues due to the fact that high-usage functions are packaged together. The hope is that by separating each of these functions into their own module, each individual module will be stable and unlikely to change, and new utility functions can be added without triggering any job queue at all.