Skip to content

Get the description from comment-based help for input and output #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 25, 2025

Conversation

adityapatwardhan
Copy link
Member

PR Summary

Ensure that we can get the typename and description from the INPUT and OUTPUT blocks from comment based help.

PR Context

Fixes #745

@adityapatwardhan
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates how the typename and description are extracted from comment-based help to address issue #745.

  • Changes the extraction of typeName from ioType.type by splitting on whitespace.
  • Changes the description extraction to remove the typeName portion from ioType.type.name.
Comments suppressed due to low confidence (1)

src/Transform/TransformBase.cs:802

  • Verify that splitting ioType.type.name by whitespace to extract the typeName correctly handles all expected formats; consider adding inline documentation to clarify the expected structure of ioType.type.name.
                    string typeName = FixUpTypeName(ioType.type.name?.Split()?[0] ?? string.Empty);

@adityapatwardhan
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Collaborator

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

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

LGTM assuming it passed your tests.

@adityapatwardhan adityapatwardhan merged commit 0e18c74 into v2 Jun 25, 2025
8 checks passed
@adityapatwardhan adityapatwardhan deleted the IODesc branch June 25, 2025 17:15
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