Update Build-PSBuildMarkdown.ps1 #67
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
While I personally agree with you that the markdown files should be overwritten, the comment above seems to indicate that the previous expectation was to not. I think the easiest way to handle this would be to accept a parameter in the function. Then we can add a Psake property to forcefully overwrite it. We can change the default in the next major version if we can come to a consensus. |
* Introduced an `Overwrite` parameter to control the overwriting of existing markdown files. * Updated relevant functions and properties to utilize the new parameter.
* Added new rules for `MD013` to disable checks for code blocks and tables. * Documented breaking changes in `CHANGELOG.md` regarding UTF-8 file compilation and markdown file overwriting.
|
Rebased off of main and signed all the commits. |
|
Looks like I can't force push this required signatures. Going to handle this in #73. |
HeyItsGilbert
added a commit
that referenced
this pull request
Mar 31, 2025
Updated New-MarkdownHelp with force parameter. This is a signed version of #67 ## Description New-MarkdownHelp should always overwrite new old markdown pages. If this is not suitable a parameter should be added to be able to force it. ## Related Issue <!--- This project only accepts pull requests related to open issues --> <!--- If suggesting a new feature or change, please discuss it in an issue first --> <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> <!--- Please link to the issue here: --> ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> This allows the comment based help to be the source of truth. ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] My code follows the code style of this project. - [ ] I have updated the documentation accordingly. - [ ] I have added this change to the CHANGELOG.md. - [ ] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. --------- Co-authored-by: Dylan Prins <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated New-MarkdownHelp with force parameter
Description
New-MarkdownHelp should always overwrite new old markdown pages.
If this is not suitable a parameter should be added to be able to force it.
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: