Skip to content

📝 Scribe: Add XML documentation for Housing Agents#98

Open
nt153133 wants to merge 1 commit into
mainfrom
scribe-housing-documentation-13727523401162380540
Open

📝 Scribe: Add XML documentation for Housing Agents#98
nt153133 wants to merge 1 commit into
mainfrom
scribe-housing-documentation-13727523401162380540

Conversation

@nt153133

@nt153133 nt153133 commented Jul 9, 2026

Copy link
Copy Markdown
Owner

💡 What: Added XML documentation to AgentHousingSignBoard and AgentHousingSelectBlock.

🎯 Why: These housing-related agents contain non-obvious domain logic, such as 1-based indexing for plots/wards and implementation-specific offset handling for lottery data, which was previously undocumented.

🔬 Examples:

/// <summary>
/// Gets the 1-based ward number of the plot.
/// </summary>
public byte Ward => (byte)(Core.Memory.Read<byte>(Pointer + AgentHousingSignBoardOffsets.Ward) + 1);

/// <summary>
/// Gets the winning lottery number for the most recent drawing on this plot.
/// </summary>
/// <remarks>
/// Implementation note: This property reads from an offset 0xC bytes after LotteryEntryCount.
/// </remarks>
public ushort WinningLotteryNumber => Core.Memory.Read<ushort>(Pointer + AgentHousingSignBoardOffsets.LotteryEntryCount + 0xC);

PR created automatically by Jules for task 13727523401162380540 started by @nt153133

- Added XML documentation to AgentHousingSignBoard and AgentHousingSelectBlock.
- Clarified 1-based indexing for Wards and Plots in AgentHousingSignBoard.
- Noted swapped offset implementation for lottery properties in AgentHousingSignBoard.
- Documented 0-based WardNumber in AgentHousingSelectBlock.
- Updated Scribe's journal with housing domain learnings.

Co-authored-by: nt153133 <[email protected]>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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