search

matthewlai / JLCKicadTools

Tool for using JLCPCB assembly service with KiCad
GNU General Public License v3.0
346 stars 62 forks source link

Add doc when argument is less than two. Improve documentation in flags. #10

Closed sophiekovalevsky closed 4 years ago

sophiekovalevsky commented 4 years ago

Thanks for this amazing tool. I find it really great for the KiCad community.

I have done a couple of changes to the script that I will describe following:

matthewlai commented 4 years ago

Thanks!

For that, I suggest to use for each metavar use uppercase and if there are more than one word, separate those by an underline.

Sounds good to me.

If there is no argument received more than just the name of script, show the user what options do they have to find more documentation.

Like @twam mentioned, there is a default for input directory. If the input directory isn't actually the project directory, the script will fail when it can't find the files it needs.

Split commands into an additional category oriented to verbosity options.

Sounds good to me.

sophiekovalevsky commented 4 years ago

Thanks!

For that, I suggest to use for each metavar use uppercase and if there are more than one word, separate those by an underline. Sounds good to me.

All right.

If there is no argument received more than just the name of script, show the user what options do they have to find more documentation. Like @twam mentioned, there is a default for input directory. If the input directory isn't actually the project directory, the script will fail when it can't find the files it needs.

What do you think about my thoughts (see discussion in specific line code above) regards this ?

Split commands into an additional category oriented to verbosity options. Sounds good to me.

All right.

matthewlai commented 4 years ago

Sorry for the late reply. Work was a bit crazy today. I have replied to the comment thread.

matthewlai commented 4 years ago

LGTM thanks for working on this!