Hi all, I've been reading the documentation (as shipped in svn) pending setting up calendarserver. The attached diffs are a few typos I found on my way. I think I have avoided "unamericanising" the text, but if theres anywhere I did feel free to ignore those changes.
There was one paragraph in HACKING I wasnt sure about, it contains "Units tests", and I wasnt sure if it needed to be "fixed", so I've left it alone. (its ~line 390-400). Thanks for your work, kk ~ Try three. Perhaps this time I'll get my email right... ~ kk -- Karl Goetz <[EMAIL PROTECTED]>
Index: HACKING =================================================================== --- HACKING (revision 2613) +++ HACKING (working copy) @@ -8,7 +8,7 @@ ============================== Although the Calendar Server is sponsored and hosted by Apple -Inc. (http://www.apple.com/), it's a true open-source project under a +Inc. (http://www.apple.com/), it's a true open-source project under an Apache license. At present, the developers work for Apple, but that's due to the project being new and originating at Apple. Contributions from other developers are welcome, and, as with all open development @@ -90,7 +90,7 @@ The vast majority of the Calendar Server is writen in the Python programming language. When writing Python code for the Calendar -Server, please observer the following conventions. +Server, please observe the following conventions. Please note that all of our code at present does not follow these standards, but that does not mean that one shouldn't bother to do so. @@ -173,7 +173,7 @@ speed=0.4, ) - * Longs lines are often due to long strings. Try to break strings up + * Long lines are often due to long strings. Try to break strings up into multiple lines: processString( @@ -186,7 +186,7 @@ multiple lines, as in the launchAtTarget example above. * It's OK to break generator expressions and list comprehensions into - mutliple lines. For example: + multiple lines. For example: myStuff = ( item.obtainUsefulValue() @@ -285,7 +285,7 @@ "And here is yet another string.", ) - * Doctrings are important. All public symbols (anything declared in + * Docstrings are important. All public symbols (anything declared in __all__) must have a correct docstring. The script docs/Developer/gendocs will generate the API documentation using pydoctor. See the pydoctor documentation for details on the @@ -351,13 +351,13 @@ Units tests can be run rather easily by executing the `test` script at the top of the Calendar Server source tree. By default, it will run all of the `twistedcaldav` tests followed by all of the `twisted` -tests. Youc an run specific tests by specifying them as arguments +tests. You can run specific tests by specifying them as arguments like this: ./test twistedcaldav.static -All non-trivial public callables must have unit tests. (Note we -totally don't comply with this rule.) All other callables should have +All non-trivial public callables must have unit tests. (Note we don't +totally comply with this rule.) All other callables should have unit tests. Units tests are written using the `twisted.trial` framework. Test
Index: doc/ical-schema.txt
===================================================================
--- doc/ical-schema.txt (revision 2613)
+++ doc/ical-schema.txt (working copy)
@@ -96,7 +96,7 @@
Services Locator
----------------
An attribute on the User, Group, Resource, and
-Location types that specifies the location of the server that his
+Location types that specifies the location of the server that is
hosting a given service.
Of the form:
@@ -114,5 +114,5 @@
1) The principal URI for that user
2) All the other records with calendars on the same server. Which is
- used in determing autocompletion for invitees and configuration of
+ used in determining autocompletion for invitees and configuration of
delegates.
Index: README
===================================================================
--- README (revision 2613)
+++ README (working copy)
@@ -63,7 +63,7 @@
This file contains a user principal, named "admin", with password
"admin", which is set up with administrative permissions on the server.
-You can then run the server thusly:
+You can then run the server thus:
./run
@@ -137,7 +137,7 @@
example, uses a database to keep track of properties on files, and this
method works on many more platforms and file systems.
-Linux and FreeBSD users have has some success running our calendar
+Linux and FreeBSD users have had some success running our calendar
server. Check our bug tracker for status:
http://trac.calendarserver.org/projects/calendarserver/report/1
signature.asc
Description: This is a digitally signed message part
_______________________________________________ calendarserver-dev mailing list [email protected] http://lists.macosforge.org/mailman/listinfo.cgi/calendarserver-dev
