Skip to content

Add a readme for the macros crate #2491

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 5 commits into
base: main
Choose a base branch
from
Open

Conversation

RickWinter
Copy link
Member

Calls out that the crate should not be used directly

Calls out that the crate should not be used directly
@Copilot Copilot AI review requested due to automatic review settings April 16, 2025 18:20
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 adds a README file for the TypeSpec Macros crate to clarify its purpose and usage.

  • Introduces documentation outlining the crate’s role in providing procedural macros for TypeSpec-generated client libraries.
  • Emphasizes that users should not use this crate directly (instead, depend on typespec_client_core) while still providing installation instructions.

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@RickWinter RickWinter requested a review from heaths April 16, 2025 19:58
@heaths
Copy link
Member

heaths commented Apr 16, 2025

Spelling error. Rather than "structs", style guide is to spell out things so just update it to "structures".

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