Skip to content

Fix formatting of docs in ///-comments for Clean() #24941

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

Merged
merged 1 commit into from
Feb 4, 2025

Conversation

sdwheeler
Copy link
Collaborator

PR Summary

Fix formatting of docs in ///-comments for Clean().

Currently the text in the ///-comments for the Clean() method is rendered as one continuous paragraph. This makes it hard to read and leads to confusion. This PR fixes the formatting of the comments so that they are rendered as separate paragraphs.

@daxian-dbw This is the fix we talked about.

PR Context

PR Checklist

@daxian-dbw daxian-dbw added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Feb 4, 2025
@daxian-dbw daxian-dbw merged commit f84c777 into PowerShell:master Feb 4, 2025
24 checks passed
Copy link
Contributor

microsoft-github-policy-service bot commented Feb 4, 2025

📣 Hey @sdwheeler, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Does SteppablePipeline.Clean() have be invoked from a compiled cmdlet for clean{} to run reliably?
2 participants