Skip to content

Improve docs and small code cleanups (Azure, union tags, request options) #475

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

carlos-code-max
Copy link

This PR fixes several documentation issues and applies small, low-risk code polish. It improves copy-paste correctness, consistency, and developer experience without changing runtime behavior.

Changes

  • README.md
  1. Fix Azure link formatting and reference URL; correct “versioning” typo.
  2. Add missing imports (fmt, os) to the Azure example.
  3. Fix middleware example duration calculation (use end.Sub(start)).
  4. Correct union struct tag backticks in the example.
  • MIGRATION.md
  1. Correct union struct tag backticks in code snippets.
  • CONTRIBUTING.md
  1. Update stated Go version to 1.21+ to match the module requirement.
  • azure/azure.go
  1. Correct version string to v0.1.0 (remove extra dot).
  2. Fix comment to reference option.WithAPIKey() (proper capitalization).
  • option/requestoption.go
  1. Use standard Authorization header capitalization.
  2. Improve WithBaseURL error message (include base URL and error via %v).
  3. Fix comment typo: “[]byte” instead of “[]bytes”.

Backwards compatibility

  • No breaking changes. HTTP headers are case-insensitive, so capitalizing Authorization does not impact behavior.

@carlos-code-max carlos-code-max requested a review from a team as a code owner August 11, 2025 11:35
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.

1 participant