Skip to content

Remove internal naming from comments and docs - #658

Merged
Corina (corinagum) merged 3 commits into
mainfrom
corinagum-remove-internal-name-from-public-docs
Aug 25, 2026
Merged

Remove internal naming from comments and docs#658
Corina (corinagum) merged 3 commits into
mainfrom
corinagum-remove-internal-name-from-public-docs

Conversation

@corinagum

Copy link
Copy Markdown
Collaborator

Clean up comments and docs

Copilot AI lite review requested due to automatic review settings August 25, 2026 18:08
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 removes internal service naming (e.g., SMBA/APX) from comments and documentation across tests, samples, and core XML docs to make the repo’s guidance more externally consumable.

Changes:

  • Updated various test/sample comments to replace internal acronyms with generic “service” wording.
  • Updated integration test README wording to remove internal naming references.
  • Renamed a demo variable from smba to serviceUrl for clearer intent.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
test/TeamsApisDemo/Program.cs Renames a local variable from smba to serviceUrl.
test/Microsoft.Teams.Core.UnitTests/Http/BotRequestContextTests.cs Updates a test comment to remove “SMBA” naming.
test/Microsoft.Teams.Apps.BotBuilder.UnitTests/CompatConversationsTests.cs Updates test comments to remove “APX” naming.
test/IntegrationTests/README.md Removes “(SMBA/APX)” from README description.
src/Microsoft.Teams.Core/Schema/ConversationExtensions.cs Updates XML docs to remove “APX” naming.
samples/PABot/Bots/SsoBot.cs Updates a sample comment to remove “APX” naming.
Suppressed comments (1)

test/Microsoft.Teams.Apps.BotBuilder.UnitTests/CompatConversationsTests.cs:436

  • Same as above: “the service” is ambiguous; prefer explicitly calling out the Bot Framework service to keep the comment actionable without using internal acronyms.
            // When the service returns 202 Accepted with no body, SendActivityAsync returns null

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread test/Microsoft.Teams.Core.UnitTests/Http/BotRequestContextTests.cs Outdated
Comment thread test/Microsoft.Teams.Apps.BotBuilder.UnitTests/CompatConversationsTests.cs Outdated
Comment thread src/Microsoft.Teams.Core/Schema/ConversationExtensions.cs Outdated
Comment thread samples/PABot/Bots/SsoBot.cs Outdated
Review feedback: "the service" is ambiguous because the code itself runs in a service. Comments only, no behavior change.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@corinagum
Corina (corinagum) added this pull request to the merge queue Aug 25, 2026
Merged via the queue into main with commit 6dac078 Aug 25, 2026
6 checks passed
@corinagum
Corina (corinagum) deleted the corinagum-remove-internal-name-from-public-docs branch August 25, 2026 18:49
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.

3 participants