Skip to content

python: Add AI-generated XAML activity docs for Python package [STUD-79291]#529

Merged
AlexMarinescuUiPath merged 3 commits intodevelopfrom
feature/python/xaml-ai-docs
Mar 30, 2026
Merged

python: Add AI-generated XAML activity docs for Python package [STUD-79291]#529
AlexMarinescuUiPath merged 3 commits intodevelopfrom
feature/python/xaml-ai-docs

Conversation

@AlexMarinescuUiPath
Copy link
Copy Markdown
Contributor

@AlexMarinescuUiPath AlexMarinescuUiPath commented Mar 20, 2026

What changed?

Added structured markdown documentation for all five Python package activities (\GetObject, \InvokeMethod, \LoadScript, \PythonScope, \RunScript) plus a package overview. Each doc covers inputs, outputs, configuration options, and copy-paste XAML examples. Files land under \Activities/Python/UiPath.Python.Packaging/docs/.

Why?

These reference docs are generated to support LLM CLI tooling (Claude Code and similar agents) that need machine-readable, per-activity context to assist developers working with the Python activity package. Tracked under STUD-79291.

Jira Link

STUD-79291

Dependencies

  • None

@AlexMarinescuUiPath AlexMarinescuUiPath enabled auto-merge (squash) March 25, 2026 07:20
@AlexMarinescuUiPath AlexMarinescuUiPath requested a review from a team March 25, 2026 12:21
@viogroza
Copy link
Copy Markdown
Collaborator

please review potential claude findings
review-ff49d00.md

@AlexMarinescuUiPath
Copy link
Copy Markdown
Contributor Author

@viogroza Thanks for the review. I addressed all points from the Claude review file.

  1. Mutually exclusive required flags fixed

    • Removed Required: Yes from Code and ScriptFile in LoadScript and RunScript.
    • Both are now documented as optional overloads with a note to provide exactly one of them.
  2. Instance display name corrected

    • Fixed the Instance property display name in InvokeMethod from 'Invoke Python Method' to 'Instance'.
  3. overview.md descriptions normalized

    • 'Invoke Python method' -> 'Invokes a method on a Python object instance.'
    • 'Python activities container' -> 'Initializes and manages the Python runtime session.'
    • 'Invoke Python script activity' -> 'Executes Python script code or a script file.'
  4. Trailing newlines added

    • Added missing trailing newlines to all 5 activity docs.

Please take another look when you have time.

@viogroza
Copy link
Copy Markdown
Collaborator

some additional findings

image

review-3dc52c9.md

…nScope.md

- Move Version from Input to Configuration table (it's a plain Property, not InArgument)
- Fix Display Name from 'Python Scope' to 'Version'
- Fix Description from 'Python activities container' to 'Python version to use. Set to Auto to detect automatically.'
- Remove Required flag (has default value Version.Auto)
@sonarqubecloud
Copy link
Copy Markdown

@AlexMarinescuUiPath AlexMarinescuUiPath merged commit 4ca6db4 into develop Mar 30, 2026
8 of 9 checks passed
@AlexMarinescuUiPath AlexMarinescuUiPath deleted the feature/python/xaml-ai-docs branch March 30, 2026 12:02
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.

2 participants