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.

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

Tests - Add tests to ensure all public commands include help information #401

Merged
merged 11 commits into from
Jul 10, 2020
Merged

Tests - Add tests to ensure all public commands include help information #401

merged 11 commits into from
Jul 10, 2020

Conversation

vexx32
Copy link
Owner

@vexx32 vexx32 commented Jul 9, 2020 •
edited
Loading

PR Summary

Add some generalized tests to ensure module help is up to snuff.

Context

Help is important! :<

Changes

  • Added test file.
  • Removed CBH in Get-Blank
  • Updated help documentation for consistency, Markdown lint fixes, etc.
  • Updated module generation to put files in en culture folder so en-GB etc culture settings can still find the help

Checklist

  • Pull Request has a meaningful title.
  • Summarised changes.
  • Pull Request is ready to merge & is not WIP.
  • Added tests / only testable interactively.
    • Make sure you add a new test if old tests do not effectively test the code changed.
  • Added documentation / opened issue to track adding documentation at a later date.

@vexx32 vexx32 added PR-Needs-Review 🔍 Let's take a closer look! Category-Tests ✅ Pertaining to tests for the module functions. labels Jul 9, 2020
@vexx32 vexx32 self-assigned this Jul 9, 2020
vexx32 added 10 commits July 9, 2020 01:45
@vexx32
📝 Update documentation
8888689 
 - Fix formatting issues in Markdown files
 - Update missing output type information
 - Add author information for commands
  - LOTS of tidying up
@vexx32
📝 Update output type metadata
7b11b8a
@vexx32
📝 Update gitignore; add help files generated
8048fde
@vexx32
🎨 Update formatter to reference correct param
52ca50a
@vexx32
📝 Remove CBH from Get-Blank
5ea0630 
PS ignores external help for functions that still have CBH lol
@vexx32
✅ Adjust test logic
cb393f9
@vexx32
✅ fix test to count properly
a2832b4
@vexx32
🚀 Update build to put help files in en
26ed74f 
 - Linux was failing since culture is en-US not en-us
 - best to just use `en` since that covers all English language cultures
@vexx32
🚀 Update publish to expect help location
ddd9606 
- `en` is a valid location just as much as `en-US` etc
@vexx32
📝 Update related links
fb2b860
@vexx32 vexx32 merged commit 430078e into main Jul 10, 2020
@vexx32 vexx32 deleted the Tests/ModuleHelp branch July 10, 2020 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steviecoaster steviecoaster Awaiting requested review from steviecoaster steviecoaster is a code owner

Assignees

@vexx32 vexx32

Labels
Category-Tests ✅ Pertaining to tests for the module functions. PR-Needs-Review 🔍 Let's take a closer look!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@vexx32