[xref-helper] Recognize API names and offer to insert xref link

Open
#570 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
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Start at the xref-helper entry point and trace how existing text is recognized and how API lookup offers replacement. Test the examples SetDebugContext and System.String, and consider the work complete when both are recognized as API names and can be offered for replacement with xref links.

Written by the indexing model from the issue text.

Description

Say you have existing text like:

SetDebugContext
System.String

The tool recognizes these strings as API names, because of the Pascal casing and/or the capitalized words separated by a period. And then it offers to look up the API and replace the text with an xref link.

Dominant language
C#
Stars
27
Forks
43
Avg merge
12h 33m
Merged PRs (30d)
26

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/docs-tools

All issues in dotnet/docs-tools

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.