dotnet / dotnet/api-docs-sync

Don't indent remarks

Open
#84 1 comment 0 reactions 0 assignees View on GitHub
port-to-docs
Dominant language
C#
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

Description

When remarks get indented by 4 spaces, they're rendered as code blocks. For example, [this PR](https://github.com/dotnet/dotnet-api-docs/pull/7054/files) introduced indentation that caused the remarks to render as code blocks. A customer fixed that in https://github.com/dotnet/dotnet-api-docs/pull/7104. The /// for the remarks is [here](https://github.com/dotnet/runtime/blob/36b6247cc7743dda997e9d671175ddc2b3e030ba/src/coreclr/System.Private.CoreLib/src/System/Runtime/DependentHandle.cs#L15) - perhaps the `` tags are causing the indentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.