Skip to content
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

Prefer xref over code-style #33853

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

Prefer xref over code-style #33853

wants to merge 5 commits into from

Conversation

mikekistler
Copy link
Contributor

@mikekistler mikekistler commented Oct 15, 2024

This PR converts code-style references to .NET classes to xref references.

Prior to this there was a mix of code-style and xref references in this file.


Internal previews

📄 File 🔗 Preview link
aspnetcore/fundamentals/openapi/aspnetcore-openapi.md aspnetcore/fundamentals/openapi/aspnetcore-openapi

Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

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

Looks good, I mention one optional format.

@mikekistler
Copy link
Contributor Author

@tdykstra @captainsafia I've switched the links to use a style like Tom suggested, but I had added one more stylistic twist. In cases where the link was to an attribute and was followed by "attribute", I moved "attribute" inside the link text. Likewise for "extension method". Here's a snip that shows how this looks now:

image

I don't have strong feelings about this but it seems worth trying. Let me know if you like it better the other way and I can easily change it.

@tdykstra
Copy link
Contributor

I don't have strong feelings about this but it seems worth trying.

I don't either, so I'd be interested in getting input from @captainsafia and @Rick-Anderson

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.

2 participants