Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port long remarks from dotnet-api-docs to docs repo #37859

Closed
gewarren opened this issue Nov 1, 2023 · 0 comments
Closed

Port long remarks from dotnet-api-docs to docs repo #37859

gewarren opened this issue Nov 1, 2023 · 0 comments
Assignees
Labels
📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@gewarren
Copy link
Contributor

gewarren commented Nov 1, 2023

Chatted with Carlos, and we agreed it probably makes sense to move any long remarks (perhaps those that contain subheadings other than Remarks or Examples) to the conceptual docs. This should be done before any reconciliation work (i.e. dotnet/dotnet-api-docs#10722).

This affects ~620 remarks sections in 172 XML files.

Regex to find remarks with subheadings other than "## R" or "## E":

<remarks>.*\n(((?!</).)*\n)*##\s+[^ER](.*\n)*?.*?</remarks>

Files to exclude:

index.xml,FrameworksIndex/*,Microsoft.VisualBasic*,System.Windows*,System.Management.Instrumentation*,System.Web*


Associated WorkItem - 189686

@gewarren gewarren self-assigned this Nov 1, 2023
@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Nov 1, 2023
@gewarren gewarren added doc-idea and removed ⌚ Not Triaged Not triaged Pri3 labels Nov 1, 2023
@gewarren gewarren moved this from 🔖 Ready to Slipped in dotnet/docs November 2023 sprint Dec 2, 2023
@gewarren gewarren added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Dec 4, 2023
@github-actions github-actions bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Dec 4, 2023
@gewarren gewarren moved this from 🔖 Ready to 🏗 In progress in dotnet/docs December 2023 sprint Dec 15, 2023
@gewarren gewarren moved this from 🏗 In progress to Slipped in dotnet/docs December 2023 sprint Jan 2, 2024
@gewarren gewarren moved this from 🔖 Ready to 🏗 In progress in dotnet/docs January 2024 sprint Jan 6, 2024
@gewarren gewarren moved this from 🏗 In progress to 👀 In review in dotnet/docs January 2024 sprint Jan 9, 2024
@gewarren gewarren moved this from 👀 In review to 🏗 In progress in dotnet/docs January 2024 sprint Jan 19, 2024
@gewarren gewarren moved this from 🏗 In progress to 👀 In review in dotnet/docs January 2024 sprint Jan 30, 2024
@gewarren gewarren moved this from 👀 In review to ✅ Done in dotnet/docs January 2024 sprint Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
No open projects
Status: Slipped
Status: ✅ Done
Status: Slipped
Development

No branches or pull requests

2 participants