Skip to content

Fix mdspell assertion failure in CHANGELOG.md #7064

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.

Sign up for GitHub

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

Jump to bottom
Merged
daxian-dbw merged 3 commits into from
Jun 14, 2018
Merged

Fix mdspell assertion failure in CHANGELOG.md #7064

daxian-dbw merged 3 commits into from
Jun 14, 2018

Conversation

@rjmholt
Copy link
Collaborator

@rjmholt rjmholt commented Jun 13, 2018

PR Summary

mdspell doesn't like the unordered list indentation in the changelog. This makes CHANGELOG.md comply with mdspell's rules.

PR Checklist

daxian-dbw
daxian-dbw reviewed Jun 14, 2018
View reviewed changes
CHANGELOG.md Outdated
- Change packaging to differentiate only between major versions and previews (#6968)
- Enhance and refactor `Add-Type` cmdlet (#6141) (Thanks @iSazonov!)
- A few error strings were removed and thus the corresponding fully-qualified error ids are not in use anymore.
+ A few error strings were removed and thus the corresponding fully-qualified error ids are not in use anymore.
Copy link
Member

@daxian-dbw daxian-dbw Jun 14, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use <sp><sp><sp><sp>- (4 spaces plus minus) to fix it. This is to keep consistent with the existing instances in this file. Thanks!

Copy link
Collaborator Author

@rjmholt rjmholt Jun 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I read the wrong rule in https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md.

Thought mdspell was complaining about MD004.

@rjmholt
Copy link
Collaborator Author

rjmholt commented Jun 14, 2018

Running the mdspell script from travis.ps1, it dumped out a number of errors -- I assumed it was noise, since the only error that appeared in the build was the indentation problem.

If they are all errors, is there a way to get a proper error dump in the build file?

If they are just noise, is there a way to improve our usage of mdspell so we're not confronted with that noise?

I'll also point out that we are using the wrong locale for mdspell and when they update the version and the locale (as the maintainer indicates they will), it will break our build again.

Issue: #6736

@daxian-dbw
Copy link
Member

daxian-dbw commented Jun 14, 2018 •
edited
Loading

it dumped out a number of errors

@rjmholt are you running mdspell locally? I don't see any errors when running mdspell "**/*.md" --ignore-numbers --ignore-acronyms (well, after changes in this PR. see below).

Yeah, the locale, we should use en-us explicitly.

bash:228> mdspell "**/*.md" --ignore-numbers --ignore-acronyms
Spelling - assets/README.md
Spelling - CHANGELOG.md
Spelling - CODE_OF_CONDUCT.md
Spelling - demos/Apache/readme.md
Spelling - demos/Azure/README.md
Spelling - demos/crontab/README.md
Spelling - demos/DSC/readme.md
Spelling - demos/powershellget/README.md
Spelling - demos/python/README.md
Spelling - demos/README.md
Spelling - demos/rest/README.md
Spelling - demos/SystemD/readme.md
Spelling - demos/WindowsPowerShellModules/README.md
Spelling - docker/README.md
Spelling - docker/tests/README.md
Spelling - docs/building/internals.md
Spelling - docs/building/linux.md
Spelling - docs/building/macos.md
Spelling - docs/building/windows-core.md
Spelling - docs/cmdlet-example/command-line-simple-example.md
Spelling - docs/cmdlet-example/visual-studio-simple-example.md
Spelling - docs/community/governance.md
Spelling - docs/debugging/README.md
Spelling - docs/dev-process/breaking-change-contract.md
Spelling - docs/dev-process/coding-guidelines.md
Spelling - docs/dev-process/resx-files.md
Spelling - docs/DOCSMIGRATION.md
Spelling - docs/FAQ.md
Spelling - docs/git/basics.md
Spelling - docs/git/README.md
Spelling - docs/git/submodules.md
Spelling - docs/host-powershell/README.md
Spelling - docs/learning-powershell/create-powershell-scripts.md
Spelling - docs/learning-powershell/debugging-from-commandline.md
Spelling - docs/learning-powershell/powershell-beginners-guide.md
Spelling - docs/learning-powershell/README.md
Spelling - docs/learning-powershell/using-vscode.md
Spelling - docs/learning-powershell/working-with-powershell-objects.md
Spelling - docs/maintainers/issue-management.md
Spelling - docs/maintainers/README.md
Spelling - docs/maintainers/releasing.md
Spelling - docs/testing-guidelines/CodeCoverageAnalysis.md
Spelling - docs/testing-guidelines/getting-code-coverage.md
Spelling - docs/testing-guidelines/PowerShellCoreTestStatus.md
Spelling - docs/testing-guidelines/testing-guidelines.md
Spelling - docs/testing-guidelines/TestRoadmap.md
Spelling - docs/testing-guidelines/WritingPesterTests.md
Spelling - README.md
Spelling - src/libpsl-native/README.md
Spelling - src/Microsoft.PowerShell.SDK/README.md
Spelling - src/Modules/README.md
Spelling - src/powershell/README.md
Spelling - src/TypeCatalogGen/README.md
Spelling - test/csharp/README.md
Spelling - test/powershell/README.md
Spelling - test/README.md
Spelling - test/tools/CodeCoverageAutomation/README.md
Spelling - test/tools/Modules/WebListener/README.md
Spelling - test/tools/WebListener/README.md
Spelling - tools/install-powershell-readme.md
Spelling - tools/releaseBuild/README.md
>> 61 files are free from spelling errors

@daxian-dbw daxian-dbw merged commit 7e05226 into PowerShell:master Jun 14, 2018
@rjmholt
Copy link
Collaborator Author

rjmholt commented Jun 14, 2018

I was running this:

PowerShell/.travis.yml

Line 49 in 6ea1389

mdspell '**/*.md' '!**/Pester/**/*.md' --ignore-numbers --ignore-acronyms --report;

And got this output:

> mdspell '**/*.md' '!**/Pester/**/*.md' --ignore-numbers --ignore-acronyms --report
    docs/git/basics.md
       37 | references to our favorites.
       49 | #### Katacoda
       52 | [Git lessons on katacoda](https://www.katacoda.com/cou
       54 | #### Githug
       56 | [Githug](https://github.com/Gazler/gi

    docs/git/README.md
       30 | * Use lowercase-with-dashes for naming.

    docs/learning-powershell/powershell-beginners-guide.md
       44 | interested in the instance of firefox process that are running on y
      134 | ld!" as a file content to the test.txt.
      135 | Because the test.txt file exists already, we use *
      173 | **8. del - Remove-Item**: Deletes the
      175 | ill delete the file /home/jen/test.txt:
      180 | **9. $PSVersionTable**: Displays the version of Po
      182 | Type **$PSVersionTable** in your PowerShell session,
      271 | th PowerShell][remoting] from Channel9
      272 | - [eBooks from PowerShell.org](https://
      272 | - [eBooks from PowerShell.org](https://powershell.org/ebook
      273 | - [eBooks from PowerShell.com][ebooks-p
      273 | - [eBooks from PowerShell.com][ebooks-powershell.com]
      274 | - [eBooks List][ebook-list] by Martin S
      274 | s List][ebook-list] by Martin Schvartzman
      279 | ting in Depth][in-depth] from Channel9
      280 | Management][remote-mgmt] from ITPro

    docs/learning-powershell/README.md
       91 | | pwd                 |pwd, $pwd, G
       91 | | pwd                 |pwd, $pwd, Get-Location      |Sho
       91 | | pwd                 |pwd, $pwd, Get-Location      |Show work
       92 | | clear, Ctrl+L, reset| cls, clear                  |Clea
       93 | | mkdir               |New-Item -Item
       93 | kdir               |New-Item -ItemType Directory |Create a new folde
       94 | | touch test.txt      |New-Item -Path test.txt
       94 | test.txt      |New-Item -Path test.txt      |Create a new empty file
       95 | | cat test1.txt test2.txt         |Get-Conten
       95 | | cat test1.txt test2.txt         |Get-Content test1.tx
       95 | est2.txt         |Get-Content test1.txt, test2.txt       |Display fil
       95 |       |Get-Content test1.txt, test2.txt       |Display files contents
       96 | | cp ./source.txt ./dest/dest.txt
       96 | | cp ./source.txt ./dest/dest.txt |Copy-Item so
       96 | | cp ./source.txt ./dest/dest.txt |Copy-Item source.tx
       96 | | cp ./source.txt ./dest/dest.txt |Copy-Item source.txt dest/de
       96 | xt ./dest/dest.txt |Copy-Item source.txt dest/dest.txt     |Copy a fil
       96 | est.txt |Copy-Item source.txt dest/dest.txt     |Copy a file
       96 | xt |Copy-Item source.txt dest/dest.txt     |Copy a file
       97 | | cp -r ./source ./dest
       97 | | cp -r ./source ./dest           |Copy-Item ./source
       97 |         |Copy-Item ./source ./dest -Recurse     |Recursively cop
       98 | | mv ./source.txt ./dest/dest.txt
       98 | | mv ./source.txt ./dest/dest.txt |Move-Item ./
       98 | | mv ./source.txt ./dest/dest.txt |Move-Item ./source.
       98 | | mv ./source.txt ./dest/dest.txt |Move-Item ./source.txt ./des
       98 |  ./dest/dest.txt |Move-Item ./source.txt ./dest/dest.txt |Move a file
       98 | txt |Move-Item ./source.txt ./dest/dest.txt |Move a file to othe
       98 | Move-Item ./source.txt ./dest/dest.txt |Move a file to other folder
       99 | | rm test.txt
       99 | | rm test.txt                     |Remove-I
       99 |                  |Remove-Item test.txt                   |Delete a f
      100 | | rm -r &lt;folderName>
      100 | | rm -r &lt;folderName>           |Remove-Item &lt;f
      100 | e>           |Remove-Item &lt;folderName> -Recurse   |Delete a folder
      102 | | grep -Rin "sometext" --include="*.
      102 | | grep -Rin "sometext" --include="*.cs" |
      102 | | grep -Rin "sometext" --include="*.cs" |Get-ChildI
      102 | r> \| Select-String -Pattern "sometext" | Recursively case-insensiti

    docs/learning-powershell/working-with-powershell-objects.md
       64 | To confirm, we can call the GetType() method interactively from t

>> 62 spelling errors found in 61 files

@rjmholt rjmholt deleted the fix-undordered-list-md branch June 22, 2018 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rjmholt @daxian-dbw