Automatically add boilerplate summary for auto-added parameterless constructors

Open
#132 0 comments 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
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Compare the generated runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml entries with the corresponding dotnet-api-docs XML files for HalfConverter, Int128Converter, and UInt128Converter. Investigate whether the parameterless constructors are compiler-generated or missing because of the artifacts path, then review the sync behavior and agree on a generic summary. Done means the cause is established and the boilerplate handling and wording are defined.

Written by the indexing model from the issue text.

Description

port-to-docs

HalfConverter, Int128Converter or UInt128Converter, have their documentation xml file created in this location:

runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml

None of these 3 APIs have an xml entry for a parameterless constructor, but it gets added to the dotnet-api-docs file automatically anyway. According to this programming guide doc, it's valid.

To fix this:

  • We need to agree on a generic boilerplate message that would apply to all APIs. Something like:

Creates a new <see cref=”T:Full.Name.Of.Type”/> instance with default values.

  • We need investigate if it’s possible to determine if a parameterless constructor was autogenerated by the compiler and that’s why I was unable to find its docs in the intellisense xml files, or if the problem was that the user provided the wrong artifacts path which does not contain the xml file with that type’s docs.
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.