Skip to content

Add a readme for the macros crate#2491

Closed
RickWinter wants to merge 5 commits intoAzure:mainfrom
RickWinter:readme
Closed

Add a readme for the macros crate#2491
RickWinter wants to merge 5 commits intoAzure:mainfrom
RickWinter:readme

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 AI review requested due to automatic review settings April 16, 2025 18:20
Copy link
Contributor

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".

@github-actions
Copy link

Hi @RickWinter. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Jun 20, 2025
@ronniegeraghty ronniegeraghty removed the no-recent-activity There has been no recent activity on this issue. label Jun 20, 2025
@azure-pipelines
Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@hallipr
Copy link
Member

hallipr commented Jul 23, 2025

/azp run rust - pullrequest

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@RickWinter
Copy link
Member Author

Run and fix cspell issues.

- `Model`: A derive macro that implements the `Model` trait, allowing a type to be deserialized from an HTTP response body.
- `SafeDebug`: A derive macro that implements debug formatting in a way that avoids leaking personally identifiable information (PII).

### The Model derive macro
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't exist anymore.

- `Model`: A derive macro that implements the `Model` trait, allowing a type to be deserialized from an HTTP response body.
- `SafeDebug`: A derive macro that implements debug formatting in a way that avoids leaking personally identifiable information (PII).

### The Model derive macro
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't exist anymore.

@RickWinter RickWinter closed this Sep 24, 2025
@RickWinter RickWinter deleted the readme branch September 24, 2025 18:05
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.

6 participants