Wolfram Function Repository
Instant-use add-on functions for the Wolfram Language
Style Guidelines
What to submit
What to submit
◼
Submissions should not substantially replicate existing functions and symbols
◼
Both functions of general interest and domain-specific functions can be submitted
◼
While submitting multiple, related functions is encouraged, each submission should stand alone and work independently
Notebook Sections
Notebook Sections
Title
Title
◼
Function names should be as specific as possible to reflect the functionality and avoid overlap with other names
See examples
◼
Names consisting of a single, common word (Step, Turn) are rarely specific enough to be published
Description
Description
◼
The text below the name should be a brief, stand-alone, plain text description of the function beginning with an imperative verb and without ending punctuation
See examples
Definition
Definition
◼
◼
Code must meet basic standards of readability, completeness, and computational efficiency
◼
Functions should perform only the specified computation, avoiding undocumented or unexpected results
◼
Aside from standard Wolfram Language symbols, all definitions must be included in the submission. No external code sources (GitHub, cloud objects, etc.) should be loaded by the function
◼
Options should be implemented using existing option symbols or string. When a resource function is created, symbols in your definitions are moved to a dedicated context. Therefore, new symbols used for option names will not work with the resource function. Instead, use either existing Wolfram Language option symbols (like and ) or strings, for example
"FabricPattern""Plaid"
See examples
◼
should be implemented using and . With this method, users will be able to specify options as symbols, for example , even if they were defined using strings
FabricPattern"Plaid"
◼
There should only be one symbol (the function name) that users interface with.
See examples
◼
See examples
◼
When using parallel functions such as in your definition, be aware that your symbols will not be in the global context when used in a resource function, and thus might exhibit different behavior when they are not matched by . See the advanced topic on parallel computing below for more information.
Documentation
Documentation
Usage
Usage
◼
Each usage (including the input pattern and text) should form a sentence and end with a period
◼
Symbols and variable names should be templated by highlighting the text and using the “Template Input” button in the Tools menu
◼
Options and their possible values should be specified in the "Details & Options" section. If your function accepts options, they are already implied in the usage.
See examples
Details & Options
Details & Options
◼
To create a hyperlink, select the desired text and choose ▶ from the menu. Specify a link destination, which can be a cell, notebook, or URL, and click OK.
Insert
Hyperlink
◼
◼
Options should be documented using a three-column table with no header row. The first column should be the option name, the second column the default value and the third column a brief description.
See examples
◼
Option names that are already documented as built-in options should be linked to their respective documentation pages using the "Template Input" button.
See examples
◼
Strings should be denoted with straight quotes (") and not curly quotes (“, ”).
See examples
Examples
Examples
◼
Basic usage scenarios should be demonstrated using clear, runnable examples with reproducible output
◼
Every input pattern in the documentation should be demonstrated by an example
◼
Within an example section, multiple examples should be separated using the “Insert Delimiter” button in the Tools bar
◼
Each example should start with a text description ending in a colon
◼
Captions should be very brief (typically no more than one sentence)
Author Notes
Author Notes
◼
Use of the section is optional
◼
Content displayed in this section can include background, possible improvements, additional information, implementation details and/or version release notes that are otherwise beyond the scope of the function documentation
Submission Notes
Submission Notes
◼
This section can be used to provide information to the reviewers on the Wolfram Function Repository Team
◼
This is especially useful for providing information about what has changed when submitting an update to your function
Advanced Topics
Advanced Topics
Choosing a CompilationTarget for Compiled functions
Choosing a CompilationTarget for Compiled functions
Parallel computing and DistributedContexts
Parallel computing and DistributedContexts
Embedding external files
Embedding external files