PortToDocs fails and exits when encountering a malformed xml

Open
#166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the PortToDocs entry point and the handling for an IntelliSense XML file without a doc element. Use the reported DotnetToolSettings.xml case to verify that the malformed file is skipped and processing continues with the remaining XML files.

Written by the indexing model from the issue text.

Description

port-to-docs

Reported by @Jozkee. The tool should skip the file and continue with the rest of the xmls. The problem was found with this file:

Looking for IntelliSense xml files...
The IntelliSense xml file does not contain a doc element: C:\git\runtime\artifacts\obj\coreclr\dotnet-pgo\DotnetToolSettings.xml
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.