Skip to content

[Bug]: core-workflows test docs use -WhatIf instead of CLI --what-if #153

@stiwicourage

Description

@stiwicourage

Summary

The documentation on https://www.novamoduletools.com/core-workflows.html#test uses the PowerShell-style -WhatIf switch in CLI-oriented wording, where it should use the command-line form --what-if.

Steps to reproduce

  1. Open https://www.novamoduletools.com/core-workflows.html#test.
  2. Go to the test workflow section.
  3. Find this text:
- Use -WhatIf if you want to preview the test run and output path without creating the results directory or invoking Pester.

Expected behavior

In command-line / nova CLI documentation, the flag should be shown as --what-if instead of the PowerShell cmdlet form -WhatIf.

Actual behavior

The page currently says:

- Use -WhatIf if you want to preview the test run and output path without creating the results directory or invoking Pester.

That wording matches PowerShell cmdlet syntax, not the command-line view.

NovaModuleTools version

2.1.1-preview04

Where did you hit the issue?

Other

Command or cmdlet

https://www.novamoduletools.com/core-workflows.html#test

Relevant output or logs

On https://www.novamoduletools.com/core-workflows.html#test
- Use -WhatIf if you want to preview the test run and output path without creating the results directory or invoking Pester.
  - is not different for command-line view. should be --what-if.

Relevant project.json snippet

{}

Operating system

macOS 26.4.1

PowerShell version

7.5.4

Shell

zsh

Installation method

Installed nova launcher

Regression?

Not sure

Additional context

This looks like end-user documentation for the CLI view, so using the PowerShell switch form is misleading. The page should use CLI-style option naming consistently where it describes nova command usage.

Pre-submit checklist

  • I searched existing issues to avoid creating a duplicate.
  • I included enough detail for someone else to reproduce the issue.
  • This is not a security vulnerability report.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions