Skip to content

Curation: Delete C++/CLI snippets where not needed #45892

Closed
@gewarren

Description

@gewarren

Describe the issue or suggestion

In the "old days", we always added API examples to the .NET docs in three languages: C#, VB, and C++/CLI. Today, we primarily add snippets in C#, sometimes also VB, and never in C++/CLI. We’ve also never had a customer request for a C++/CLI code example.

As far as maintenance goes, if one of these older code snippets needs to be updated, then it needs to be updated in 3 languages. Also, many of these code examples use now-obsolete APIs and/or outdated syntax. Given that C++/CLI has numerous restrictions on .NET (Core) (for example, it only runs on Windows) and doesn’t seem to be commonly used except as a thin interop layer, we propose deleting the C++/CLI snippets from the .NET docs except for in the following areas:

• Interop docs
• .NET Framework-specific docs

  • Delete inline C++ snippet refs
  • Delete code-cpp style snippet refs
  • Delete code language="cpp" snippet refs
  • Run CleanRepo to delete the now orphaned snippets
  • Generate a report for no. of delete snippet files
    • Run git log --diff-filter=D --summary 7b30062..HEAD | grep 'delete mode' | wc -l in dotnet-api-docs to see that over 2K .cpp files were deleted.
  • Rerun CI and don't generate C++/CLI API signatures - see CI update - delete C++/CLI signatures dotnet-api-docs#11413

Associated WorkItem - 423793

Metadata

Metadata

Assignees

Labels

📌 seQUESTeredIdentifies that an issue has been imported into Quest.okr-curationOKR: Curate content to remove outdated recommendationsresolved-by-customer

Type

No type

Projects

Status

✅ Done

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions