search

irotech / google-styleguide

Automatically exported from code.google.com/p/google-styleguide
0 stars 0 forks source link

No word about standard date format in lispguide.xml, how about http://www.w3.org/TR/NOTE-datetime #11

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
What steps will reproduce the problem?
1. 
https://google-styleguide.googlecode.com/svn/trunk/lispguide.xml?showone=Attenti
on_Required#Attention_Required
2.
3.

What is the expected output? What do you see instead?

I would expect the "Google Common Lisp Style Guide" to specify the format dates 
in comments should be in. My strong preference would be towards ISO 8601, to 
spare readers the bafflement which is 1/2/3 or 03.02.01.

The only mention of date is in the example below.
While "November, 2012" is unambiguous enough, it leaves the reader with no 
recommendation for representing specific dates or date-time.

Here is the excerpt:

Be specific when indicating times or software releases in a TODO comment:

;;--- TODO(brown): Remove this code after release 1.7 or before November, 2012.

What version of the product are you using? On what operating system?

Please provide any additional information below.

Using a standard date-time format would make it a lot easier for humans and for 
tooling to extract useful temporal information from program comments.

Original issue reported on code.google.com by adrian.a...@gmail.com on 11 Oct 2012 at 11:31

GoogleCodeExporter commented 9 years ago 
Ah,
http://google-styleguide.googlecode.com/svn/trunk/xmlstyle.html
already has something to say about dates.

How about something similar for "Google Common Lisp Style Guide"?

7. Values

...

Dates should be represented using RFC 3339 format, a subset of both ISO 8601 
format and XML Schema xsd:dateTime format.  UTC times SHOULD be used rather 
than local times.  [Rationale: There are far too many date formats and time 
zones, although it is recognized that sometimes local time preserves important 
information.]

Original comment by adrian.a...@gmail.com on 11 Oct 2012 at 11:54

GoogleCodeExporter commented 9 years ago

Original comment by mark@chromium.org on 28 Nov 2012 at 8:42