Skip to content

Add ConsoleKey.None and ConsoleModifiers.None - #83114

Merged
terrajobst merged 1 commit into
dotnet:mainfrom
terrajobst:console-modifiers
Mar 8, 2023
Merged

Add ConsoleKey.None and ConsoleModifiers.None#83114
terrajobst merged 1 commit into
dotnet:mainfrom
terrajobst:console-modifiers

Conversation

@terrajobst

@terrajobstterrajobst commented Mar 7, 2023

Copy link
Copy Markdown
Contributor

Submitted as draft PR to have a CI pass with tests. Will mark as ready for review when it passes.

This fixes#79868.

@ghost

ghost commented Mar 7, 2023

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghostghost assigned terrajobstMar 7, 2023
@ghost

ghost commented Mar 7, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/area-system-console
See info in area-owners.md if you want to be subscribed.

Issue Details

This fixes #79868.

Author:terrajobst
Assignees:-
Labels:

area-System.Console, new-api-needs-documentation

Milestone:-

@terrajobst

Copy link
Copy Markdown
ContributorAuthor

Unless I'm mistaken it doesn't seem the failures are related to this change, so I'm going to mark it ready.

@terrajobst
terrajobst marked this pull request as ready for review March 8, 2023 01:26
{
public enum ConsoleKey
{
None = 0x0,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carlossanlop, do these need XML docs?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Area owners can document these new enum values in dotnet-api-docs directly.

Assuming this change makes it into Preview3, that build will get released on April 11: https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/31692/NET-8-Schedule . On that day, we will update dotnet-api-docs to start showing Preview3 in the MS Docs .NET version dropdown. When that happens, area owners can document the new enums in the dotnet-api-docs xmls:

By the way, I don't know if you also wanted to know this, but fortunately all the old enum values area already documented in dotnet-api-docs:

So only the new two enum values will need docs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the process is we merge this first, tooling will update the XML files and then I can submit a PR to add the text?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typical process is we use xml comments on new apis and then those are used to seed the docs. It sounds like Carlos is saying you could also wait and submit a pr to the docs repo for these later.

@terrajobstterrajobstMar 8, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I also submitted a PR for that; if that's the wrong way of doing it, I can also wait until the tooling populated the files for the new members.

dotnet/dotnet-api-docs#8893

@terrajobst
terrajobst merged commit 9624a79 into dotnet:mainMar 8, 2023
@terrajobst
terrajobst deleted the console-modifiers branch March 8, 2023 19:43
@ghostghost locked as resolved and limited conversation to collaborators Apr 8, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal]: Add ConsoleModifiers.None and ConsoleKey.None

3 participants

@terrajobst@carlossanlop@stephentoub