(AB-161630) Refactor and extend class docs #10615
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
michaeltlombardi
force-pushed
the
ab-161630/main/about-classes-edit
branch
from
0465787
to
dba5574
Compare
This comment was marked as outdated.
This comment was marked as outdated.
sdwheeler
reviewed
Nov 8, 2023
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
michaeltlombardi
force-pushed
the
ab-161630/main/about-classes-edit
branch
from
ef32837
to
ff596ae
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Prior to this change, the class documentation did not go into sufficient detail for the syntax, definition, and limitations of class members. This change decomposes the `about_Classes` documentation into multiple files: - `about_Classes` - overview, basic information, full list of limitations. - `about_Classes_Properties` - Full documentation for defining class properties. - `about_Classes_Methods` - Full documentation for defining class methods. - `about_Classes_Constructors` - Full documentation for defining class constructors. - `about_Classes_Inheritance` - Full documentation for defining classes that inherit from a base class or implement an interface. This change fixes AB#161630.
michaeltlombardi
force-pushed
the
ab-161630/main/about-classes-edit
branch
from
ff596ae
to
e325ccf
Compare
2 tasks
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs
that referenced
this pull request
Jan 23, 2024
In MicrosoftDocs#10615, the section for the `NoRunspaceAfinnity` attribute was erroneously deleted as part of the reorganization of the about_Classes article. This change: - Adds back the documentation and examples for the `NoRunspaceAffinity` to the 7.4 and 7.5 versions of about_Classes, as well as a note about the default behavior in the general limitations section. - Adds a section and example showing the behavior for corrupted runspaces due to class runspace affinity in the 7.2 and 7.3 versions, and updates the limitations section. - Resolves MicrosoftDocs#10818 - Fixes AB#202807
4 tasks
sdwheeler
pushed a commit
that referenced
this pull request
Jan 23, 2024
In #10615, the section for the `NoRunspaceAfinnity` attribute was erroneously deleted as part of the reorganization of the about_Classes article. This change: - Adds back the documentation and examples for the `NoRunspaceAffinity` to the 7.4 and 7.5 versions of about_Classes, as well as a note about the default behavior in the general limitations section. - Adds a section and example showing the behavior for corrupted runspaces due to class runspace affinity in the 7.2 and 7.3 versions, and updates the limitations section. - Resolves #10818 - Fixes AB#202807
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Prior to this change, the class documentation did not go into sufficient detail for the syntax, definition, and limitations of class members.
This change decomposes the
about_Classesdocumentation into multiple files:about_Classes- overview, basic information, full list of limitations.about_Classes_Properties- Full documentation for defining class properties.about_Classes_Methods- Full documentation for defining class methods.about_Classes_Constructors- Full documentation for defining class constructors.about_Classes_Inheritance- Full documentation for defining classes that inherit from a base class or implement an interface.This change fixes AB#161630.
PR Checklist