-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Fixed formatting on expanded example #1861
Conversation
The formatting on the MS page looks really convoluted with the expanded example so I changed the example into one large codeblock for consistent formatting
|
File | Status | Preview URL | Details |
---|---|---|---|
reference/5.1/Microsoft.PowerShell.Core/About/about_pipelines.md | Details |
reference/5.1/Microsoft.PowerShell.Core/About/about_pipelines.md
- [Warning] Ignore metadata: locale. They are generated by open publish.
For more details, please refer to the build report.
Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.
@joeyaiello @zjalexander - What do you think about this formatting change? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see the problem. I love the effort to think about it. I would like to either have the codeblocks be all plain or have just the ascii art blocked off and plain. I think all-plain is slightly better and easier, but would like some additional discussion.
| ( FileInfo objects ) | ||
| ( .txt ) | ||
| | ||
V | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hm, the above should probably be in a plain codeblock (no powershell language indicator) so the ASCII art doesn't get syntax highlighted? but then you would need to alternate between PS code blocks and plain code blocks? or just have the entire thing in plain codeblocks...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another solution I thought of in hindsight, having a code block in one example, and another below that code block with the object types of the pipeline (instead of the commands)
@TheIncorrigible1 - Thank you for your contribution. After some deliberation I am closing this PR unmerged. We talked about this internally and liked some of the changes you made and we had other ideas. I had to reformat this topic as part of the issue #1806 efforts. So I incorporated this into my changes. cc: @zjalexander |
The formatting on the MS page looks really convoluted with the expanded example so I changed the example into one large codeblock for consistent formatting
Version(s) of document impacted
Reason(s) for not updating all version of documents