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

about_Classes doesn't mention the Experimental or System.Obsolete attributes #10138

Closed
3 tasks done
michaeltlombardi opened this issue Jun 5, 2023 · 0 comments · Fixed by #10200
Closed
3 tasks done
Assignees
Labels
area-about Area - About_ topics area-core Area - Microsoft.PowerShell.Core module issue-doc-bug Issue - error in documentation

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, "Typo in Get-Foo cmdlet" instead of "Typo."
  • Verify Version: If there is a mismatch between documentation and the behavior on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.

Links

Summary

The about_Classes article discusses several useful attributes and practices for developing PowerShell classes, but it doesn't cover using the Experimental attribute to mark a class or property as experimental, nor using the System.Obsolete attribute to mark a class, property, or method as obsolete.

Both practices are useful for PowerShell developers and can impact the user experience for their modules and classes.

Details

A common development need is to mark new functionality as experimental or replaced functionality as obsolete. Further, PowerShell developers might want to build functionality on PowerShell's own experimental features.

Suggested Fix

Extend the documentation in about_Classes to cover experimental and obsolete classes and class members.

@michaeltlombardi michaeltlombardi added area-core Area - Microsoft.PowerShell.Core module area-about Area - About_ topics issue-doc-bug Issue - error in documentation labels Jun 5, 2023
@sdwheeler sdwheeler self-assigned this Jun 23, 2023
michaeltlombardi added a commit that referenced this issue Jun 23, 2023
* Expand information about variable attributes

* Apply suggestions from code review

Co-authored-by: Mikey Lombardi (He/Him) <michael.t.lombardi@gmail.com>

* Feedback suggestions

---------

Co-authored-by: Mikey Lombardi (He/Him) <michael.t.lombardi@gmail.com>
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 issue-doc-bug Issue - error in documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants