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

Update-MarkdownHelp adding back in a space that VSCode removes #225

Closed
rkeithhill opened this issue Oct 29, 2016 · 8 comments
Closed

Update-MarkdownHelp adding back in a space that VSCode removes #225

rkeithhill opened this issue Oct 29, 2016 · 8 comments
Labels
Help wanted Tag - Help wanted from the community to resolve this issue
Milestone

Comments

@rkeithhill
Copy link

Steps to reproduce

Set up VSCode to trim trailing whitespace.
Create a markdown for a function.
Save it from VSCode with trim trailing whitespace enabled.
Run Update-MarkdownHelp on the markdown file.

Expected behavior

The command should not modify the file because we haven't changed it.

Actual behavior

The command is adding back in a space after Aliases::
image

Environment data

v0.7.2

@rkeithhill
Copy link
Author

Sure would be nice if platyPS didn't add the space after Aliases: in the first place. That would play better with editors like VSCode where users can configure the editor to trim trailing whitespace automatically which is very useful for PowerShell scripts.

@vors
Copy link
Collaborator

vors commented Dec 21, 2016

Agree, it would be nice to have.
Should be pretty easy to add.

@vors vors added this to the 0.8.0 milestone Dec 21, 2016
@vors vors added the Help wanted Tag - Help wanted from the community to resolve this issue label Dec 22, 2016
@BernieWhite
Copy link
Contributor

Might look at taking this one on, still in the latest build, and it is annoying me :)

@vors
Copy link
Collaborator

vors commented Nov 9, 2017

Ah that's a good one! @BernieWhite let me know if you have any questions

@BernieWhite
Copy link
Contributor

BernieWhite commented Nov 9, 2017

Thanks. So do you think any sort of feature switches are going be required, or will trailing spaces always be removed?

@BernieWhite
Copy link
Contributor

@vors This one turned out to be broader then expected. Existing help used in unit tests use trailing whitespace in multiple places.

It wasn't something that could easily be solved, so the fix was scoped to only address yaml blocks used for header and parameters, which will address @rkeithhill original request.

@vors
Copy link
Collaborator

vors commented Nov 9, 2017

Always removed

vors pushed a commit that referenced this issue Nov 9, 2017
* Fix to clean up trailing whitespace in during markdown generation #225

* Updated change log with reference to issue #225

* Update to fix test issues
@vors
Copy link
Collaborator

vors commented Nov 9, 2017

Fixed in #225

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Help wanted Tag - Help wanted from the community to resolve this issue
Projects
None yet
Development

No branches or pull requests

3 participants