Skip to content

update: minor clarifications to refactoring requirements - #425

Closed
suspect15 wants to merge 1 commit into
RetroAchievements:mainfrom
suspect15:patch-3use
Closed

suspect15 wants to merge 1 commit into
RetroAchievements:mainfrom
suspect15:patch-3use

Conversation

@suspect15

Copy link
Copy Markdown
Contributor

Adds guidance on general game notes, provides an example of a static array, and cleans up some example formatting.

@suspect15 suspect15 closed this Sep 19, 2026
@suspect15
suspect15 deleted the patch-3use branch September 19, 2026 15:38
@greptile-apps

greptile-apps Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

Safe to merge after minor documentation cleanup.

Summary

Adds static-array examples, general game-note guidance, and formatting cleanup.

Reviews (1) · Last reviewed commit: "update: minor clarifications to refactor..."


General game note example:
```
[General game notes]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Missing Address Size

This general note omits the address size required by this page, making the guidance inconsistent.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment on lines 91 to +100
```
[32-bit] pointer to enemy object array
+0x00= [10x12 bytes] Enemy object array
+|0x00= [32-bit] ID
..0x00= Monster A
..0x01= Monster B
..0x02= Monster C
+|0x04= [32-bit] Health
+|0x08= [32-bit] Model Pointer
+|+0x04= [Float] Position X
+|+0x08= [Float] Position Y
[6x4 bytes] Enemy object array
|0x00=Enemy ID [8-bit]
.0x00=Slime
.0x01=Ghost
.0x02=Wolf
|0x01=Enemy max HP [8-bit]
|0x02=Enemy current HP [8-bit]
|0x03=Enemy level [8-bit]
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Ambiguous Unsupported Notation

The warning follows only the pointer-array example, so readers may wrongly assume this new static-array notation is supported.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


### General Game Note

Occasionally, in order to more easily understand how a game functions, some general game notes are useful to inform maintainers. In cases where the refactorer feels a general game note will added significant benefit, it may be made on address 0x00000000 using the header **[General game notes]**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Incorrect Wording and Terminology

“Will added” is ungrammatical, and “code node” conflicts with the established “code note” term on line 139. Both reduce clarity.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant