[Pymoul-svn] SF.net SVN: pymoul: [110] pymoul/trunk
Status: Alpha
Brought to you by:
tiran
Menu
▾
▴
[Pymoul-svn] SF.net SVN: pymoul: [110] pymoul/trunk
|
From: <ti...@us...> - 2007-01-31 15:40:57
|
Revision: 110
http://pymoul.svn.sourceforge.net/pymoul/?rev=110&view=rev
Author: tiran
Date: 2007-01-31 07:40:51 -0800 (Wed, 31 Jan 2007)
Log Message:
-----------
Small doc string adjustments to make epydoc happy
Modified Paths:
--------------
pymoul/trunk/Makefile.in
pymoul/trunk/genepydoc.py
pymoul/trunk/src/moul/file/wdysini.py
pymoul/trunk/src/moul/osdependent/processinfo.py
pymoul/trunk/src/moul/osdependent/singleapp.py
pymoul/trunk/src/moul/qt/mainwindow.py
pymoul/trunk/src/moul/qt/moulqt.py
pymoul/trunk/src/moul/time/cavern.py
pymoul/trunk/src/moul/time/dni.py
Modified: pymoul/trunk/Makefile.in
===================================================================
--- pymoul/trunk/Makefile.in 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/Makefile.in 2007-01-31 15:40:51 UTC (rev 110)
@@ -45,8 +45,14 @@
PYTHONPATH="src" $(PYTHON) test.py $(TESTFLAGS) $(TESTOPTS)
doc_html:
- PYTHONPATH="src" $(EPYDOC) -v --html --output="doc/html" moul
+ PYTHONPATH="src" $(EPYDOC) -v --html --no-sourcecode \
+ --output="doc/html" moul
+doc_html_graph:
+ PYTHONPATH="src" $(EPYDOC) -v --html --no-sourcecode --graph=all \
+ --output="doc/html" moul
+
+
# What should the default be?
test: test_inplace
Modified: pymoul/trunk/genepydoc.py
===================================================================
--- pymoul/trunk/genepydoc.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/genepydoc.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -8,13 +8,13 @@
#from epydoc.docstringparser import register_field_handler
STANDARD_FIELDS.append(
- DocstringField(['slots', 'qtslots'], 'Qt Slot: %s', 'Qt Slots: %s',
+ DocstringField(['slot', 'qtslot'], 'Qt Slot', 'Qt Slots',
short=False, multivalue=True, takes_arg=True)
)
STANDARD_FIELDS.append(
- DocstringField(['signal', 'qtsignal'], 'Emits Qt Signal: %s',
- 'Emit Qt Signals: %s', short=False, multivalue=True,
+ DocstringField(['signal', 'qtsignal'], 'Emits Qt Signal',
+ 'Emit Qt Signals', short=False, multivalue=True,
takes_arg=True)
)
Modified: pymoul/trunk/src/moul/file/wdysini.py
===================================================================
--- pymoul/trunk/src/moul/file/wdysini.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/file/wdysini.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -347,8 +347,10 @@
up, the new data is written to another file and at last the original
file is replaced with the new file.
- WINDOWS: os.rename() can't replace the file in place under Windows.
- The final operation is not atomic. :(
+ WINDOWS
+ -------
+ os.rename() can't replace the file in place under Windows. The final
+ operation is not atomic. :(
"""
orig = self._fpath
if orig is None:
@@ -382,7 +384,8 @@
def parseString(self, s):
"""Parse string with file contents
- @param s newline seperated file (string)
+ @param s: newline seperated file
+ @type s: string
"""
self.clear()
lines = s.split('\n')
Modified: pymoul/trunk/src/moul/osdependent/processinfo.py
===================================================================
--- pymoul/trunk/src/moul/osdependent/processinfo.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/osdependent/processinfo.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -17,11 +17,12 @@
#
"""Get process informations
-API:
- getPids() - list of ints/longs
- getPidNames() - mapping pid -> name
- getPidDetails(pid) - detailed informations about a process
- getPidDetails('self') - detailed informations about current process
+API
+===
+ getPids() - list of ints/longs
+ getPidNames() - mapping pid -> name
+ getPidDetails(pid) - detailed informations about a process
+ getPidDetails('self') - detailed informations about current process
>>> cur = os.getpid()
>>> exe = sys.executable
Modified: pymoul/trunk/src/moul/osdependent/singleapp.py
===================================================================
--- pymoul/trunk/src/moul/osdependent/singleapp.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/osdependent/singleapp.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -17,10 +17,9 @@
#
"""Simple single instance application
-Includes portalocker code with minor tweaks for Python 2.4+
- Author: Jonathan Feinberg <jd...@po...>
- Version: $Id$
- http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65203
+Includes portalocker code with minor tweaks for Python 2.4+ from
+Jonathan Feinberg <jd...@po...>
+http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65203
Unit tests for lock/unlock are in tests/test_singleapp
@@ -38,6 +37,7 @@
>>> singleapp.release()
>>> os.path.isfile(lckfile)
False
+
"""
__author__ = "Christian Heimes"
__version__ = "$Id$"
Modified: pymoul/trunk/src/moul/qt/mainwindow.py
===================================================================
--- pymoul/trunk/src/moul/qt/mainwindow.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/qt/mainwindow.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -95,6 +95,9 @@
@signalLogDecorator(LOG)
def on_moulIsRunning(self, boolean):
+ """
+ @qtslot moulIsRunning(bool): notify if moul is running
+ """
sb = self.statusbar
boolean = bool(boolean)
if boolean is not self._moulrunning:
@@ -125,7 +128,9 @@
"""
Close event handler
- @param event close event (QCloseEvent)
+ @qtslot closeEvent(event QCloseEvent): notify on close
+ @param event: close event
+ @type event: QCloseEvent instance
"""
#if self._dirty:
# event.reject()
@@ -137,9 +142,11 @@
def keyPressEvent(self, event):
"""
Key event handler
-
- @param event key event (QKeyEvent)
-
+
+ @qtslot keyPressEvent(event QKeyEvent): notify on key pressed
+ @param event: key event
+ @type event: QKeyEvent
+
Has to ignore unknown events
"""
#if event.key() == Qt.Key_Escape:
@@ -189,7 +196,7 @@
@signalLogDecorator(LOG)
def on_graphicsini_loaded(self):
"""
- SIGNAL graphicsini_loaded()
+ @qtslot graphicsini_loaded(): notify when a graphics.ini is loaded
"""
inipath = lookupDir('ini')
self._graphics_ini = gini = GraphicsIni()
Modified: pymoul/trunk/src/moul/qt/moulqt.py
===================================================================
--- pymoul/trunk/src/moul/qt/moulqt.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/qt/moulqt.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -41,13 +41,13 @@
"""Main application
Flow diagram:
- * create app
- * check if other instance of pymoulqt is running
- o exit app if another instance is running
- * create log file handler
- * check if URU is running
- o exit if URU is running
- * Show the main window
+ - create app
+ - check if other instance of pymoulqt is running
+ - exit app if another instance is running
+ - create log file handler
+ - check if URU is running
+ - exit if URU is running
+ - Show the main window
"""
LOG.info("Starting PyMoul QT UI with argv %s" % repr(args))
app = QtGui.QApplication(*args)
Modified: pymoul/trunk/src/moul/time/cavern.py
===================================================================
--- pymoul/trunk/src/moul/time/cavern.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/time/cavern.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -117,14 +117,14 @@
zone. Call a CavernTime object:
utc
- datetime -- Current time in UTC as <datetime> object
+ - datetime -- Current time in UTC as <datetime> object
cavern, pacific
- datetime -- current time TZ as <datetime> object
- tz -- time zone object
- dst -- dst in seconds if dst
- utcoffset -- (signum, hours, fraction) offset from UTC
- name -- long time like US/Mountain
- id -- short name like MST
+ - datetime -- current time TZ as <datetime> object
+ - tz -- time zone object
+ - dst -- dst in seconds if dst
+ - utcoffset -- (signum, hours, fraction) offset from UTC
+ - name -- long time like US/Mountain
+ - id -- short name like MST
>>> ct = CavernTime()
>>> result = ct()
Modified: pymoul/trunk/src/moul/time/dni.py
===================================================================
--- pymoul/trunk/src/moul/time/dni.py 2007-01-31 14:57:57 UTC (rev 109)
+++ pymoul/trunk/src/moul/time/dni.py 2007-01-31 15:40:51 UTC (rev 110)
@@ -67,28 +67,28 @@
The DniTime class assumes the following rules:
- * Hahrtee Farah 1 started on 21st of April 7656 B.C.
- * Hahrtee Fahrah 15 started 1719 A.C.
- * A new hahr starts on 21st of April.
- * The reference time for the calculation is Mountain Standard Time (MST)
- without (!) DST. The UTC offset is always UTC-7.
- * To compensate leap years a new hahr starts on midnight (0:00am) in every
- forth year (year % 4 == 0).
- * To simplify the code special cases like year % 100 and year % 400 are
- NOT taken into account. I'm assuming a year has 365,25 days (which is
- wrong). A year according to the Gregorian Calendar has 365,2425 days.
+ - Hahrtee Farah 1 started on 21st of April 7656 B.C.
+ - Hahrtee Fahrah 15 started 1719 A.C.
+ - A new hahr starts on 21st of April.
+ - The reference time for the calculation is Mountain Standard Time (MST)
+ without (!) DST. The UTC offset is always UTC-7.
+ - To compensate leap years a new hahr starts on midnight (0:00am) in every
+ forth year (year % 4 == 0).
+ - To simplify the code special cases like year % 100 and year % 400 are
+ NOT taken into account. I'm assuming a year has 365,25 days (which is
+ wrong). A year according to the Gregorian Calendar has 365,2425 days.
Overview
- ---------
+ --------
- fahrah millenium 625 years
- hahr year 1 year
- vailee month 10 per year
- yahr day 29 per vailee, about 30h 14min
- gahrtahvo section about 6h, 3min
- tahvo quarter about 14,5min
- gorahn minute 36 seconds
- prorahn second about 1.3929 seconds
+ fahrah millenium 625 years
+ hahr year 1 year
+ vailee month 10 per year
+ yahr day 29 per vailee, about 30h 14min
+ gahrtahvo section about 6h, 3min
+ tahvo quarter about 14,5min
+ gorahn minute 36 seconds
+ prorahn second about 1.3929 seconds
"""
_fahrah = None # millenium (625 years)
_hahr = None # year (1 year)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
