Don't indent remarks

Open
#84 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Compare the linked PRs 7054 and 7104 with the triple-slash remarks in DependentHandle.cs, then trace the api-docs-sync conversion that handles tags and indentation. Done means remarks no longer gain four-space indentation and render as code blocks.

Written by the indexing model from the issue text.

Description

port-to-docs

When remarks get indented by 4 spaces, they're rendered as code blocks. For example, this PR 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 - perhaps the <para> tags are causing the indentation.

Dominant language
C#
Stars
14
Forks
21
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/api-docs-sync

All issues in dotnet/api-docs-sync

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.