-
Notifications
You must be signed in to change notification settings - Fork 976
Add example for C2290 error reference #5701
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
base: main
Are you sure you want to change the base?
Add example for C2290 error reference #5701
Conversation
Learn Build status updates of commit b3e3f96: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
@TylerMSFT - Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
There was a problem hiding this 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 improves the documentation for compiler error C2290 by updating the error message format, enhancing the remarks section with helpful links, and adding a practical code example. The changes make the error reference more comprehensive and useful for developers encountering this inline assembly syntax issue.
- Updated error message formatting to use proper quotation marks around 'asm'
- Enhanced remarks section with links to relevant inline assembler documentation
- Added a complete code example demonstrating both the error-causing syntax and the correct alternative
## Remarks | ||
|
||
The **`asm`** syntax is reserved for future use. | ||
The **`asm`** syntax is reserved for future use, try [`__asm`](../../assembler/inline/asm.md) instead. For more information, see [Inline Assembler](../../assembler/inline/inline-assembler.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider adding a space after the comma for better readability: 'reserved for future use. Try [__asm
]...' instead of 'reserved for future use, try [__asm
]...'
Copilot uses AI. Check for mistakes.
Update error message, augment remarks, and add example.