[PS] Syntax?? or Usage?? in built-in Help files

Discussion in 'Scripting' started by Andrew Watt [MVP], May 16, 2006.

  1. There seems to have been a change in how Help files are structured and
    examples seem not to have been appropriately updated.

    I *think* that Usage has replaced Syntax, as a section label.

    However, some examples ... for example when using Help suspend-service
    (Example 4 in get-help get-help) ... still refer to Syntax when in
    fact it's now a Usage section.

    Run help suspend-service "live" and the fourth section is "Usage". In
    Example 4 of help get-help it's "Syntax".

    It's more confusing when you run the following two commands.

    Run
    help (get-command).syntax
    and you see TOPIC, SHORT DESCRIPTION, LONG DESCRIPTION. SYNTAX
    relating to the get-help cmdlet.

    Run
    help get-help
    and you see NAME, SYNOPSIS, DETAILED DESCRIPTION, USAGE
    for the get-help cmdlet.

    I wonder if the former command is accessing some earlier version of
    Help structured a bit like the about_something help files. I don't see
    the file in the v1.0 folder though.

    Comments?

    Andrew Watt MVP
     
    Andrew Watt [MVP], May 16, 2006
    #1
    1. Advertisements

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments (here). After that, you can post your question and our members will help you out.