larryhastings / appeal

Command-line parsing library for Python 3.
Other
122 stars 7 forks source link

Add notes on `*` #11

Open bartbroere opened 11 months ago

bartbroere commented 11 months ago

Last week at EuroPython I attended the talk on Appeal and was immediately convinced this was exactly what I needed.

My takeaway from the talk was that I should only add the decorator and I should be good to go, but I didn't pay close enough attention. Even though the README says we should use keyword-only arguments, I had to find out the hard way.

In this PR I suggest some very explicit side-notes to the README. People who are new to Python might not be familiar with the syntax required to force keyword arguments. My personal experience is that you can use Python for a long time before learning about them. Adding these notes might make Appeal even more accessible.