Skip to content

📝 Scribe: Add XML documentation for RemoteAgents#111

Open
nt153133 wants to merge 1 commit into
mainfrom
jules-scribe-agents-documentation-10678382684761110550
Open

📝 Scribe: Add XML documentation for RemoteAgents#111
nt153133 wants to merge 1 commit into
mainfrom
jules-scribe-agents-documentation-10678382684761110550

Conversation

@nt153133

Copy link
Copy Markdown
Owner

What

This PR adds comprehensive triple-slash XML documentation to the following undocumented or under-documented classes in the RemoteAgents namespace:

  • AgentDeepDungeonStatus
  • AgentGoldSaucerInfo
  • AgentHousing
  • AgentHousingSelectBlock
  • AgentMinionNoteBook
  • AgentWorldTravelSelect

Why

These FFXIV remote agents interact directly with game memory and UI, making accurate documentation critical for maintainability. The comments explain the underlying memory mappings, indices (such as zero-based vs. one-based indexes), and regional compilation differences.

Examples

AgentHousingSelectBlock

/// <summary>
/// Gets or sets the selected ward index.
/// </summary>
/// <value>The zero-based index of the ward (e.g., 0 represents Ward 1, 1 represents Ward 2, etc.).</value>
public int WardNumber

AgentWorldTravelSelect

/// <summary>
/// Gets the list of available world choices for cross-world travel, skipping the home world if applicable based on region.
/// </summary>
public WorldChoice[] Choices

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

…Info, Housing, HousingSelectBlock, MinionNoteBook, WorldTravelSelect)

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