arrow-py / arrow

🏹 Better dates & times for Python
https://arrow.readthedocs.io
Apache License 2.0
8.7k stars 673 forks source link

No documentation of format of get() and format() #1005

Closed alexchandel closed 3 years ago

alexchandel commented 3 years ago

Issue Description

There is no documentation of all the allowed format characters for arrow.get() and Arrow.format(). The documentation mentions a few examples, like arrow.get('June was born in May 1980', 'MMMM YYYY') and arrow.utcnow().format('YYYY-MM-DD HH:mm:ss ZZ'), but these are far from exhaustive.

For example, how does one output a human-readable weekday name, like "Thursday, July 4"? Even python's datetime has datetime.datetime.now().strftime('%A') and datetime.date.today().strftime('%A'). Surely arrow can at least do this in its format()?

The source of parser.py and formatter.py show quite a few format characters that aren't exhibited in the documentation. Please document the meaning of/difference between all these.

jadchaar commented 3 years ago

Hi @alexchandel, the token documentation can be found here.