Para tags are mangled when explicitly declared in remarks in combination with new-lines

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Start by comparing the remarks in CollectionsMarshal.cs at lines 50-60 with the generated api-docs change linked in the issue. Trace how explicitly declared para tags and newlines are handled by the documentation-sync tool. Done means the tool no longer emits escaped para tags that require manual fixup.

Written by the indexing model from the issue text.

Description

See https://github.com/dotnet/runtime/blob/925205d06d82ce5e0d24e4e313fd66887fe89795/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/CollectionsMarshal.cs#L50-L60

This produced escaped para tags that required fixup https://github.com/dotnet/dotnet-api-docs/commit/88e32343860fb4f40d147a602f982f753bbaa027#diff-f01295b45b7c030a49d50f0e76b8ffb9e41e3c2238ae1bc6097cc1b781570ad5L61

We should investigate what's going wrong and fix the tool

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.