Skip to content

📝 Scribe: Add XML documentation for LlamaLibrary.Utilities.Inventory#109

Open
nt153133 wants to merge 1 commit into
mainfrom
scribe-inventory-docs-11171766489519409473
Open

📝 Scribe: Add XML documentation for LlamaLibrary.Utilities.Inventory#109
nt153133 wants to merge 1 commit into
mainfrom
scribe-inventory-docs-11171766489519409473

Conversation

@nt153133

Copy link
Copy Markdown
Owner

💡 What: Added high-quality, comprehensive XML documentation (triple-slash comments) for the static utility class LlamaLibrary.Utilities.Inventory. This covers the class definition, fields/properties (IsBusy, InventoryBagIds, ArmoryBagIds), and core automation tasks (CofferTask, UseUnlockablesAsync, Desynth, ReduceAll, ExtractFromAllGear).

🎯 Why: This static utility class is heavily relied upon for primary inventory actions across various botbases and plugins but completely lacked XML documentation. Tracing and detailing its specific domain behaviors (like looking for Coffer Action ID 388, listing collectible item action categories, or the minimum level requirement of 30 for desynthesis) is crucial for developers working with FFXIV memory mapping and inventory management.

🔬 Examples:

/// <summary>
/// Scans the player's primary inventory for useable items that unlock collectible game content and uses them sequentially.
/// Collectibles are identified by checking the backing action ID:
/// <list type="bullet">
/// <item><description><c>853</c>: Minions</description></item>
/// <item><description><c>25183</c>: Orchestrion Rolls</description></item>
/// <item><description><c>3357</c>: Triple Triad Cards</description></item>
/// <item><description><c>2136</c>: Master Crafting Books</description></item>
/// <item><description><c>4107</c>: Folklore Gathering Tomes</description></item>
/// </list>
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public static async Task UseUnlockablesAsync()

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

@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