Skip to content

Update Header Comment Documentation#1277

Merged
Bloo-dev merged 5 commits into
Gamemode4Dev:masterfrom
Bloo-dev:header-comment-documentation-update
May 3, 2026
Merged

Update Header Comment Documentation#1277
Bloo-dev merged 5 commits into
Gamemode4Dev:masterfrom
Bloo-dev:header-comment-documentation-update

Conversation

@Bloo-dev

@Bloo-dev Bloo-dev commented Feb 28, 2026

Copy link
Copy Markdown
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

runcows commented Mar 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

runcows
runcows reviewed Mar 3, 2026
View reviewed changes
Comment thread docs/code-conventions.md Outdated
@Bloo-dev

Bloo-dev commented Mar 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

I have elaborated on omitted namespaces.

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

self or this? CC @misode @BPR02 @runcows @TheThanathor

@Bloo-dev

Bloo-dev commented May 3, 2026

Copy link
Copy Markdown
Member Author
image

misode
misode reviewed May 3, 2026
View reviewed changes
Comment thread docs/code-conventions.md Outdated
@Bloo-dev
Allow wildcards in macro key descriptions
d079c01 
Updated documentation to allow wildcards in macro key descriptions.
@Bloo-dev Bloo-dev merged commit d9f3882 into Gamemode4Dev:master May 3, 2026
2 checks passed
@Bloo-dev Bloo-dev deleted the header-comment-documentation-update branch May 3, 2026 20:16
github-actions Bot pushed a commit that referenced this pull request May 3, 2026
@Bloo-dev
🚀 d9f3882 Update Header Comment Documentation (#1277)
1b671a4 
* Update Header Comment Documentation

* Add Note on Omitted Namespace

* Add more run from options

* Allow wildcards in macro key descriptions

Updated documentation to allow wildcards in macro key descriptions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@misode misode misode approved these changes

+2 more reviewers

@catter1 catter1 catter1 approved these changes

@runcows runcows runcows approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Bloo-dev @runcows @misode @catter1