Skip to content

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

@mikekistler
Copy link
Contributor Author

@captainsafia convinced me that we should not put "attribute" or "extension method" inside the link text, so I just pushed another commit that reverts that stylistic twist.

I think this is good to go now. @captainsafia can you please give it a quick review & approval and then I will merge.

@mikekistler mikekistler merged commit a31bbf1 into main Oct 18, 2024
2 checks passed
@mikekistler mikekistler deleted the mdk/embrace-xref branch October 18, 2024 20:59
@guardrex
Copy link
Collaborator

@mikekistler ... Please squash your PRs when merging.

@mikekistler
Copy link
Contributor Author

@guardrex Apologies -- I will try to remember to do this next time.

@guardrex
Copy link
Collaborator

No worries ... just keeping the history tidy 😄 .

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.

5 participants