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

Decompose and extend about_Classes #10575

Closed
2 tasks done
michaeltlombardi opened this issue Oct 25, 2023 · 1 comment
Closed
2 tasks done

Decompose and extend about_Classes #10575

michaeltlombardi opened this issue Oct 25, 2023 · 1 comment
Assignees
Labels
area-about Area - About_ topics area-core Area - Microsoft.PowerShell.Core module area-language Area - PowerShell syntax and keywords issue-doc-idea Issue - request for new content

Comments

@michaeltlombardi
Copy link
Contributor

Prerequisites

  • Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
  • Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new Get-Foo cmdlet" instead of "New cmdlet."

PowerShell Version

5.1, 7.2, 7.3, 7.4

Summary

As a PowerShell module author or PSDSC Resource author, I want to have accurate, detailed information about how to define PowerShell classes and their members, including syntax, patterns, and limitations, so that I can effectively write and maintain PowerShell classes.

Details

The current about_Classes documentation is limited and not up-to-date. The content should be reworked into multiple files with extended documentation:

  • about_Classes - overview, syntax, high-level information about members, info on creating instances, and full list of limitations.
  • about_Classes_Properties - syntax, overview, examples, patterns, relevant limitations.
  • about_Classes_Constructors - syntax, overview, examples, patterns, relevant limitations.
  • about_Classes_Methods - syntax, overview, examples, patterns, relevant limitations.

Proposed Content Type

About Topic

Proposed Title

No response

Related Articles

No response

@michaeltlombardi michaeltlombardi added issue-doc-idea Issue - request for new content needs-triage Waiting - Needs triage labels Oct 25, 2023
@michaeltlombardi michaeltlombardi self-assigned this Oct 25, 2023
@michaeltlombardi michaeltlombardi added area-core Area - Microsoft.PowerShell.Core module area-language Area - PowerShell syntax and keywords area-about Area - About_ topics and removed needs-triage Waiting - Needs triage labels Oct 25, 2023
@michaeltlombardi
Copy link
Contributor Author

Implemented in #10615

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-about Area - About_ topics area-core Area - Microsoft.PowerShell.Core module area-language Area - PowerShell syntax and keywords issue-doc-idea Issue - request for new content
Projects
None yet
Development

No branches or pull requests

1 participant