Skip to content

Conversation

LarryOsterman
Copy link
Member

Also:

Removed a significant number of unused HTTP headers from azure_core.

@LarryOsterman LarryOsterman marked this pull request as ready for review September 12, 2025 18:19
@Copilot Copilot AI review requested due to automatic review settings September 12, 2025 18:19
Copy link
Contributor

@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 enables documentation warnings in the azure_core and azure_identity packages and removes a significant number of unused HTTP headers from azure_core. The changes aim to improve code documentation consistency and eliminate dead code.

Key changes include:

  • Added #![warn(missing_docs)] directive to enforce documentation standards
  • Added comprehensive documentation to numerous public types, methods and fields
  • Simplified HTTP header constants by removing unused ones
  • Made struct fields public and removed accessor methods in favor of direct field access
  • Added documentation comments to macro-generated content

Reviewed Changes

Copilot reviewed 57 out of 57 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
sdk/typespec/typespec_client_core/src/http/request/options/mod.rs Added documentation to APPLICATION_JSON variant in ContentType macro
sdk/typespec/typespec_client_core/src/http/request/options/macros.rs Enhanced macro to support documentation attributes for variants
sdk/identity/azure_identity/src/lib.rs Added missing_docs warning directive
sdk/identity/azure_identity/src/managed_identity_credential.rs Added comprehensive documentation to public types and methods
sdk/identity/azure_identity/src/developer_tools_credential.rs Added method documentation and changed test helper visibility
sdk/identity/azure_identity/src/client_secret_credential.rs Added detailed documentation for credential creation
sdk/identity/azure_identity/src/azure_pipelines_credential.rs Added struct documentation
Multiple AMQP and messaging files Changed from accessor methods to direct field access for better ergonomics
sdk/core/azure_core/src/lib.rs Added missing_docs warning and documentation
sdk/core/azure_core/src/http/request/options/mod.rs Significantly simplified by removing unused HTTP header constants
sdk/core/azure_core_*/src/lib.rs Added missing_docs warnings and comprehensive documentation

@heaths heaths marked this pull request as draft September 12, 2025 19:22
Copy link
Member

@heaths heaths left a comment

Choose a reason for hiding this comment

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

There were a few other instances of warn that should be expect so we remember to clean it up in the future and not allow subsequent violations.

Mainly holding because this changes azure_core and we need to wait until after the service crates ship next week.

Also, be sure to update the sdk/core/azure_core/CHANGELOG.md file. With as many headers as you removed, you may not have to be quite so specific since we haven't even GA'd yet. Maybe even just "Remove a lot of unused headers." in Breaking Changes would be fine.

@github-project-automation github-project-automation bot moved this from Untriaged to In Progress in Azure Identity SDK Improvements Sep 12, 2025
@heaths heaths marked this pull request as ready for review September 12, 2025 19:33
@LarryOsterman LarryOsterman marked this pull request as draft September 15, 2025 20:01
@LarryOsterman
Copy link
Member Author

Marked as Draft until Core versions are updated.

@LarryOsterman LarryOsterman marked this pull request as ready for review September 17, 2025 22:25
@heaths heaths enabled auto-merge (squash) September 17, 2025 22:37
@heaths heaths merged commit a5835c1 into Azure:main Sep 17, 2025
17 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure Identity SDK Improvements Sep 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core The azure_core crate Azure.Identity The azure_identity crate
Projects
Development

Successfully merging this pull request may close these issues.

Remove lease from azure_core models Make sure all public APIs are documented
2 participants