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

[Docs] Update Shell inline comments #20912

Merged
merged 87 commits into from
May 7, 2024
Merged

[Docs] Update Shell inline comments #20912

merged 87 commits into from
May 7, 2024

Conversation

jsuarezruiz
Copy link
Contributor

Description of Change

Update Shell inline docs.

@jsuarezruiz jsuarezruiz added area-docs Conceptual docs, API docs, Samples t/housekeeping ♻︎ labels Feb 29, 2024
@jsuarezruiz jsuarezruiz marked this pull request as ready for review February 29, 2024 10:11
@jsuarezruiz jsuarezruiz requested a review from a team as a code owner February 29, 2024 10:11
@jsuarezruiz jsuarezruiz changed the title [Docs] Update Shell inline docs [Docs] Update Shell inline comments Mar 1, 2024
Copy link
Contributor

@jknaudt21 jknaudt21 left a comment

Choose a reason for hiding this comment

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

I love that we're making progress on documenting Shell. However, since this class receives a lot of traffic and views, I would encourage you to review the DotNet style guide: https://github.com/dotnet/dotnet-api-docs/wiki/Summary

The things that quickly standout for me thus far have been:

Nonetheless, other than these generic observations, things look good!

src/Controls/src/Core/Shell/Shell.cs Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
src/Controls/src/Core/Shell/Shell.cs Outdated Show resolved Hide resolved
@jknaudt21
Copy link
Contributor

jknaudt21 commented Mar 1, 2024

Adding @davidbritch as a reviewer to help craft these docs to the best shape.

jsuarezruiz and others added 25 commits April 11, 2024 10:31
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>
Copy link
Contributor

@jknaudt21 jknaudt21 left a comment

Choose a reason for hiding this comment

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

Existing docs look good to me. I guess we can move the deleting the xml file and shifting the docs into another PR to no longer block this one

@PureWeen PureWeen merged commit 5a95d45 into main May 7, 2024
49 checks passed
@PureWeen PureWeen deleted the docs-shell-class branch May 7, 2024 19:34
@github-actions github-actions bot locked and limited conversation to collaborators Jun 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-docs Conceptual docs, API docs, Samples t/housekeeping ♻︎
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants