Short-form to fully qualified object naming - #381
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Python docstrings across dialogs, core hosting, and activity libraries to use fully qualified object names, to support Learn API reference generation.
Changes:
- Replace short-form
:class:,:meth:, and:attr:references with fully qualified names (e.g.,microsoft_agents.hosting.dialogs.WaterfallDialog). - Update return/parameter documentation to reference fully qualified types in prompts, dialogs, proactive, and activity APIs.
- Standardize doc references across core app/proactive builder APIs to qualified
:rtype:/:return:targets.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/waterfall_step_context.py | Fully qualifies dialog and method references in WaterfallStepContext docstrings. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/waterfall_dialog.py | Fully qualifies waterfall step context, end-of-turn, and method references. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/prompts/prompt_options.py | Fully qualifies prompt and choice prompt type references. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/prompts/confirm_prompt.py | Fully qualifies PromptCultureModels reference. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/prompts/choice_prompt.py | Fully qualifies reference to _default_choice_options. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/prompts/attachment_prompt.py | Fully qualifies Attachment type reference. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/prompts/activity_prompt.py | Fully qualifies prompt lifecycle method/type references and Dialog.end_of_turn. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/models/dialog_reason.py | Fully qualifies dialog context/step context method references in enum docs. |
| libraries/microsoft-agents-hosting-dialogs/microsoft_agents/hosting/dialogs/component_dialog.py | Fully qualifies component dialog and related method/type references. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/proactive/proactive.py | Fully qualifies proactive API references (methods, attrs, options). |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/proactive/conversation_reference_builder.py | Fully qualifies fluent builder :rtype: references. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/proactive/conversation_builder.py | Fully qualifies fluent builder :rtype: references. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/proactive/conversation.py | Fully qualifies conversation factory/method references. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/input_file.py | Fully qualifies InputFile references in downloader docs. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/app_options.py | Fully qualifies AgentApplication.proactive attribute reference. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/app/agent_application.py | Fully qualifies AgentApplication.add_route reference in route decorator docs. |
| libraries/microsoft-agents-hosting-core/microsoft_agents/hosting/core/activity_handler.py | Fully qualifies ActivityHandler method references in docstrings/notes. |
| libraries/microsoft-agents-activity/microsoft_agents/activity/activity.py | Fully qualifies Activity references in factory method docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 18 out of 18 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Axel Suárez (axelsrz)
previously approved these changes
May 1, 2026
Member
|
Peter Hecke (@phecke) could you please check if copilot comments are accurate? |
…sting/dialogs/models/dialog_reason.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…sting/dialogs/models/dialog_reason.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ng/core/app/input_file.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ng/core/activity_handler.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…sting/dialogs/models/dialog_reason.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/Agents-for-python/sessions/e970df0c-5cf0-464d-9eb3-93883a4a612c Co-authored-by: phecke <10079935+phecke@users.noreply.github.com>
Member
Author
|
Copilot apply changes based on the comments in this thread |
Contributor
All review comments from the referenced thread have already been addressed in previous commits:
The working tree is clean with no pending changes. |
Axel Suárez (axelsrz)
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change all docstrings from using object short-form naming to the fully qualified name. This is required for generation of the Learn API reference.