Skip to content

Update the --help\ -h option output #39

@sophia-gh

Description

@sophia-gh

The current output of the command ./nameCollector -h is:

nameCollector: Output all user defined identifier names in a srcML file (i.e., one or more source code files).  
Usage: ./nameCollector [OPTIONS]

Options:
  -h,--help                   Print this help message and exit
  -i,--input TEXT             Name of srcML file of source code with --position option
  -o,--output TEXT            Name of output file
  -f,--format TEXT            The output format (text by default): csv, text
  -a,--append                 Output will be appended to end of file
  -c,--csv                    Output csv with header (same as --format csv)
  -n,--noheader               Do not print header in csv output
  -d,--debug                  Turn on debug mode (off by default)

This output should be updated with more current information such as supported languages and a more detailed description of the tool's functionality.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions