Skip to content

Update Header Comment Documentation#1277

Open
Bloo-dev wants to merge 1 commit intoGamemode4Dev:masterfrom
Bloo-dev:header-comment-documentation-update
Open

Update Header Comment Documentation#1277
Bloo-dev wants to merge 1 commit intoGamemode4Dev:masterfrom
Bloo-dev:header-comment-documentation-update

Conversation

@Bloo-dev
Copy link
Member

Implements new documentation for header comments.

@Bloo-dev Bloo-dev added the quality-update Improves efficiency or structure without affecting functionality of a module label Feb 28, 2026
@runcows
Copy link
Contributor

runcows commented Mar 3, 2026

For run from and similar header comments, do we want the <locator> to be namespaced 100% of the time like we have in current documentation and this PR?
I've adopted a habit of dropping the namespace if it is the same as the current one.

Edit:
We should also revisit run from self and if we still agree with that notation

- `run from <locator>` The full resource locator of a function that calls this function. Use of wildcards, e.g. `run from gm4:boats/*` is permitted.
- `scheduled from <locator>` The full resource locator of a function that schedules this function. Use of wildcards, e.g. `run from gm4:boats/*` is permitted.
- `rewarded from <locator>` The full resource locator of an advancement that rewards this function. Use of wildcards, e.g. `run from gm4:join/*` is permitted.
- `with $<key>: <description>` The key of an nb tag used for the macro call of this function, as well as a description of the value the key holds. Do not specify this unless this function is a macro. Use of wildcards, e.g. `with $id_*: Set of 16 ids used to track runcows.`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `with $<key>: <description>` The key of an nb tag used for the macro call of this function, as well as a description of the value the key holds. Do not specify this unless this function is a macro. Use of wildcards, e.g. `with $id_*: Set of 16 ids used to track runcows.`
- `with $<key>: <description>` The key of an nbt tag used for the macro call of this function, as well as a description of the value the key holds. Do not specify this unless this function is a macro. Use of wildcards, e.g. `with $id_*: Set of 16 ids used to track runcows.`

Copy link
Member Author

@Bloo-dev Bloo-dev Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A named binary tag tag?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am ashamed to admit that I forgot what nbt stood for.,.,., but it does still feel weird to me to see "nb tag"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

quality-update Improves efficiency or structure without affecting functionality of a module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants