You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 26, 2020. It is now read-only.
This may be a bit trivial, but annoying never the less... This also is a more general problem, that just in the manual, but an example in rendering.html:
<!-- Creation date: 01/03/02 -->
So when? Probably the middle one is not the year, but still I would not bet if the year 2001 or 2002 or if the month is (depending on which year you want it to be) January, February or March. Comparing the marking to other files I know, that in this particular case the first one is the year, but there is no way of telling about the rest.
Some of the files don't have a date marked and that's fine too but from maintenance point of view, it'd be nice to know when that file has been edited last. As of formatting, the year should always be written in four digits and I'd suggest to write the month as an abbreviation rather than a number. For example:
The benefit of the three-digit abbreviation as the month compared to the full name of a month is the constant field length, which improves readability.
The text was updated successfully, but these errors were encountered:
It probably depends on who worked on the file. European English speakers (Britain, esp.) tend to use dd/mm/yy, while U.S. prefers mm/dd/yy. Much of the rest of the world uses yyyy/mm/dd
Something to think about, but I really think that we sorry if need to review must of the manual anyway.
This may be a bit trivial, but annoying never the less... This also is a more general problem, that just in the manual, but an example in
rendering.html
:<!-- Creation date: 01/03/02 -->
So when? Probably the middle one is not the year, but still I would not bet if the year 2001 or 2002 or if the month is (depending on which year you want it to be) January, February or March. Comparing the marking to other files I know, that in this particular case the first one is the year, but there is no way of telling about the rest.
Some of the files don't have a date marked and that's fine too but from maintenance point of view, it'd be nice to know when that file has been edited last. As of formatting, the year should always be written in four digits and I'd suggest to write the month as an abbreviation rather than a number. For example:
The benefit of the three-digit abbreviation as the month compared to the full name of a month is the constant field length, which improves readability.
The text was updated successfully, but these errors were encountered: