Skip to content

Fix backtick formatting problem in grain-identity.md#52782

Open
JohannesEH wants to merge 1 commit intodotnet:mainfrom
JohannesEH:orleans/fix-backtick-formatting-problem
Open

Fix backtick formatting problem in grain-identity.md#52782
JohannesEH wants to merge 1 commit intodotnet:mainfrom
JohannesEH:orleans/fix-backtick-formatting-problem

Conversation

@JohannesEH
Copy link
Copy Markdown

@JohannesEH JohannesEH commented Apr 1, 2026

Summary

Added additional surrounding backticks in markdown to escape backtick in content.

Fixes #52781


Internal previews

📄 File 🔗 Preview link
docs/orleans/grains/grain-identity.md Grain identity

@JohannesEH JohannesEH requested a review from meaghanlewis as a code owner April 1, 2026 14:38
Copilot AI review requested due to automatic review settings April 1, 2026 14:38
@JohannesEH JohannesEH requested a review from ReubenBond as a code owner April 1, 2026 14:38
@dotnetrepoman dotnetrepoman bot added this to the April 2026 milestone Apr 1, 2026
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates PR is created by someone from the .NET community. label Apr 1, 2026
Copy link
Copy Markdown
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 fixes an inline Markdown formatting issue in the Orleans grain identity documentation by properly escaping a backtick-containing attribute so it renders correctly.

Changes:

  • Wrap the [GrainType("dict2")]` example in an inline code span that can safely contain a backtick.
  • Update the surrounding sentence to use the corrected inline formatting.

```

The grain class has two generic parameters, so a backtick `` ` `` followed by the generic arity, 2, is added to the end of the grain type name `dict` to create the grain type name ``dict`2``. This is specified in the attribute on the grain class: `[GrainType("dict`2")]`.
The grain class has two generic parameters, so a backtick `` ` `` followed by the generic arity, 2, is added to the end of the grain type name `dict` to create the grain type name ``dict`2``. This is specified in the attribute on the grain class: ``[GrainType("dict`2")]``.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The inline code span includes escaped quotes ("). In Markdown code spans, backslashes render literally, so readers will see " in the attribute instead of normal quotes. Remove the backslashes so the rendered attribute uses standard C# syntax with plain double quotes.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Indicates PR is created by someone from the .NET community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Small markdown backtick formatting problem in Orleans Grain Identity documentation

2 participants