haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cli: help string cleanup 

- fix some typos
- capitalization consistency
- Reword exit code argument
This commit is contained in:
Graham Keeth 2023-11-20 22:28:19 -05:00 committed by Ian McInerney
parent 98dca3b774
commit 5f189ec3fd
7 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
kicad/cli/command_pcb_drc.cpp
View File

@ -81,7 +81,7 @@ CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND() : COMMAND( "drc" )
.default_value( false );
m_argParser.add_argument( ARG_EXIT_CODE_VIOLATIONS )
.help( UTF8STDSTR( _( "Return a exit code depending on whether or not violations exist" ) ) )
.help( UTF8STDSTR( _( "Return a nonzero exit code if DRC violations exist" ) ) )
.implicit_value( true )
.default_value( false );
}

4
kicad/cli/command_pcb_export_3d.cpp
View File

@ -140,13 +140,13 @@ CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND( const std::string& aNa
m_argParser.add_argument( ARG_VRML_UNITS )
.default_value( std::string( "in" ) )
.help( UTF8STDSTR(
_( "Output units; ascii or csv format only; valid options: mm, m, in, tenths" ) ) );
_( "Output units; valid options: mm, m, in, tenths" ) ) );
m_argParser.add_argument( ARG_VRML_MODELS_DIR )
.default_value( std::string( "" ) )
.help( UTF8STDSTR(
_( "Name of folder to create and store 3d models in, if not specified or "
"empty, the models will be embedded in main exported vrml file" ) ) );
"empty, the models will be embedded in main exported VRML file" ) ) );
m_argParser.add_argument( ARG_VRML_MODELS_RELATIVE )
.help( UTF8STDSTR( _( "Used with --models-dir to output relative paths in the resulting file" ) ) )

2
kicad/cli/command_sch_erc.cpp
View File

@ -74,7 +74,7 @@ CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND() : COMMAND( "erc" )
.default_value( false );
m_argParser.add_argument( ARG_EXIT_CODE_VIOLATIONS )
.help( UTF8STDSTR( _( "Return a exit code depending on whether or not violations exist" ) ) )
.help( UTF8STDSTR( _( "Return a nonzero exit code if ERC violations exist" ) ) )
.implicit_value( true )
.default_value( false );
}

2
kicad/cli/command_sch_export_bom.cpp
View File

@ -32,7 +32,7 @@
CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND() : COMMAND( "bom" )
{
m_argParser.add_description( UTF8STDSTR( _( "Generate a Bill of Material (BOM)" ) ) );
m_argParser.add_description( UTF8STDSTR( _( "Generate a Bill of Materials (BOM)" ) ) );
addCommonArgs( true, true, false, false );
// Preset options

4
kicad/cli/command_sch_export_bom.h
View File

@ -27,10 +27,10 @@ namespace CLI
{
// Options for selecting presets of the export, e.g. GroupedByValue and CSV
#define ARG_PRESET "--preset"
#define ARG_PRESET_DESC "Use a named BOM preset settings from the schematic, e.g. \"Grouped By Value\"."
#define ARG_PRESET_DESC "Use a named BOM preset setting from the schematic, e.g. \"Grouped By Value\"."
#define ARG_FMT_PRESET "--format-preset"
#define ARG_FMT_PRESET_DESC "Use a named BOM format preset settings from the schematic, e.g. CSV."
#define ARG_FMT_PRESET_DESC "Use a named BOM format preset setting from the schematic, e.g. CSV."
// Options for setting the format of the export, e.g. CSV
#define ARG_FIELD_DELIMITER "--field-delimiter"

2
kicad/cli/command_sch_export_netlist.cpp
View File

@ -32,7 +32,7 @@
CLI::SCH_EXPORT_NETLIST_COMMAND::SCH_EXPORT_NETLIST_COMMAND() : COMMAND( "netlist" )
{
m_argParser.add_description( UTF8STDSTR( _( "Export a Netlist" ) ) );
m_argParser.add_description( UTF8STDSTR( _( "Export a netlist" ) ) );
addCommonArgs( true, true, false, false );
m_argParser.add_argument( ARG_FORMAT )

4
kicad/cli/command_sch_export_pythonbom.cpp
View File

@ -33,8 +33,8 @@ CLI::SCH_EXPORT_PYTHONBOM_COMMAND::SCH_EXPORT_PYTHONBOM_COMMAND() :
{
addCommonArgs( true, true, false, false );
m_argParser.add_description( UTF8STDSTR( _( "Export the legacy bom xml format used in the "
"schematic editor with python scripts" ) ) );
m_argParser.add_description( UTF8STDSTR( _( "Export the legacy BOM XML format used in the "
"schematic editor with Python scripts" ) ) );
}