Skip to content

Commit

Permalink
fixes formatting in readme and documents an override variable (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
hry-gh authored Aug 6, 2024
1 parent b8451ff commit 84960f7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Zola allows us to put arbitrary TOML under the [extra] section, which we do for
- Procs:
- `return_type_desc` - This allows us to add extra information about the return type - for example, what specific return types mean. It can also be used to document the return type if not pulled from DMStandard.
- `[[args.description]]` - We can document individual arguments to procs with the `description` field. These edits will not be removed by the Autodocumentation tool.
- `[[args.od_unimplemented]] - If this argument is implemented or not in the OpenDream implementation of BYOND.
- `[[args.od_unimplemented]]` - If this argument is implemented or not in the OpenDream implementation of BYOND.
- `[[args.type_override]]` - This type will be used instead of the type pulled from DMStandard.
- Vars:
- `default_value_desc` - This allows us to add extra information about the default value that this variable is set to.

Expand Down

0 comments on commit 84960f7

Please sign in to comment.