[Epydoc-commits] SF.net SVN: epydoc: [1678] trunk/epydoc/src/epydoc
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1678] trunk/epydoc/src/epydoc
|
From: <ed...@us...> - 2008-01-29 17:21:31
|
Revision: 1678
http://epydoc.svn.sourceforge.net/epydoc/?rev=1678&view=rev
Author: edloper
Date: 2008-01-29 09:21:29 -0800 (Tue, 29 Jan 2008)
Log Message:
-----------
Fixed spelling error (supress -> suppress)
Modified Paths:
--------------
trunk/epydoc/src/epydoc/cli.py
trunk/epydoc/src/epydoc/docbuilder.py
trunk/epydoc/src/epydoc/docintrospecter.py
trunk/epydoc/src/epydoc/docstringparser.py
Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py 2008-01-29 17:16:38 UTC (rev 1677)
+++ trunk/epydoc/src/epydoc/cli.py 2008-01-29 17:21:29 UTC (rev 1678)
@@ -792,13 +792,13 @@
else:
print >>sys.stderr, '\nUnsupported action %s!' % options.action
- # If we supressed docstring warnings, then let the user know.
- if logger is not None and logger.supressed_docstring_warning:
- if logger.supressed_docstring_warning == 1:
+ # If we suppressed docstring warnings, then let the user know.
+ if logger is not None and logger.suppressed_docstring_warning:
+ if logger.suppressed_docstring_warning == 1:
prefix = '1 markup error was found'
else:
prefix = ('%d markup errors were found' %
- logger.supressed_docstring_warning)
+ logger.suppressed_docstring_warning)
log.warning("%s while processing docstrings. Use the verbose "
"switch (-v) to display markup errors." % prefix)
@@ -1125,7 +1125,7 @@
etc) that have been reported. It is used by the options
--fail-on-warning etc to determine the return value."""
- self.supressed_docstring_warning = 0
+ self.suppressed_docstring_warning = 0
"""This variable will be incremented once every time a
docstring warning is reported tothe logger, but the verbosity
level is too low for it to be displayed."""
@@ -1202,7 +1202,7 @@
message = self._format(' Debug: ', message, self.term.CYAN)
else:
if level >= log.DOCSTRING_WARNING:
- self.supressed_docstring_warning += 1
+ self.suppressed_docstring_warning += 1
return
self._report(message)
Modified: trunk/epydoc/src/epydoc/docbuilder.py
===================================================================
--- trunk/epydoc/src/epydoc/docbuilder.py 2008-01-29 17:16:38 UTC (rev 1677)
+++ trunk/epydoc/src/epydoc/docbuilder.py 2008-01-29 17:21:29 UTC (rev 1678)
@@ -265,14 +265,14 @@
log.start_progress('Parsing docstrings')
valdocs = sorted(docindex.reachable_valdocs(
imports=False, submodules=False, packages=False, subclasses=False))
- supress_warnings = set(valdocs).difference(
+ suppress_warnings = set(valdocs).difference(
docindex.reachable_valdocs(
imports=False, submodules=False, packages=False, subclasses=False,
bases=False, overrides=True))
for i, val_doc in enumerate(valdocs):
_report_valdoc_progress(i, val_doc, valdocs)
# the value's docstring
- parse_docstring(val_doc, docindex, supress_warnings)
+ parse_docstring(val_doc, docindex, suppress_warnings)
# the value's variables' docstrings
if (isinstance(val_doc, NamespaceDoc) and
val_doc.variables not in (None, UNKNOWN)):
@@ -283,7 +283,7 @@
if (isinstance(var_doc.value, ValueDoc)
and var_doc.value.defining_module is UNKNOWN):
var_doc.value.defining_module = val_doc.defining_module
- parse_docstring(var_doc, docindex, supress_warnings)
+ parse_docstring(var_doc, docindex, suppress_warnings)
log.end_progress()
# Take care of inheritance.
@@ -422,7 +422,7 @@
try:
_, parse_docs = _get_docs_from_pyname(
str(introspect_doc.canonical_name), options,
- progress_estimator, supress_warnings=True)
+ progress_estimator, suppress_warnings=True)
finally:
options.introspect = prev_introspect
@@ -437,7 +437,7 @@
return (introspect_doc, parse_doc)
def _get_docs_from_pyname(name, options, progress_estimator,
- supress_warnings=False):
+ suppress_warnings=False):
progress_estimator.complete += 1
if options.must_introspect(name) or options.must_parse(name):
log.progress(progress_estimator.progress(), name)
@@ -460,7 +460,7 @@
pass
# Report any errors we encountered.
- if not supress_warnings:
+ if not suppress_warnings:
_report_errors(name, introspect_doc, parse_doc,
introspect_error, parse_error)
@@ -1247,7 +1247,7 @@
"""
Set the C{overrides} attribute for all variables in C{class_doc}.
This needs to be done early (before docstring parsing), so we can
- know which docstrings to supress warnings for.
+ know which docstrings to suppress warnings for.
"""
for base_class in list(class_doc.mro(warn_about_bad_bases=True)):
if base_class == class_doc: continue
Modified: trunk/epydoc/src/epydoc/docintrospecter.py
===================================================================
--- trunk/epydoc/src/epydoc/docintrospecter.py 2008-01-29 17:16:38 UTC (rev 1677)
+++ trunk/epydoc/src/epydoc/docintrospecter.py 2008-01-29 17:21:29 UTC (rev 1678)
@@ -893,7 +893,7 @@
"""
Run the given callable in a 'sandboxed' environment.
Currently, this includes saving and restoring the contents of
- sys and __builtins__; and supressing stdin, stdout, and stderr.
+ sys and __builtins__; and suppressing stdin, stdout, and stderr.
"""
# Note that we just do a shallow copy of sys. In particular,
# any changes made to sys.modules will be kept. But we do
@@ -908,7 +908,7 @@
# in get_value_from_filename might get overwritten
sys.path.append('')
- # Supress input and output. (These get restored when we restore
+ # Suppress input and output. (These get restored when we restore
# sys to old_sys).
sys.stdin = sys.stdout = sys.stderr = _dev_null
sys.__stdin__ = sys.__stdout__ = sys.__stderr__ = _dev_null
Modified: trunk/epydoc/src/epydoc/docstringparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docstringparser.py 2008-01-29 17:16:38 UTC (rev 1677)
+++ trunk/epydoc/src/epydoc/docstringparser.py 2008-01-29 17:21:29 UTC (rev 1678)
@@ -167,7 +167,7 @@
# asked to process one twice? e.g., for @include we might have to
# parse the included docstring earlier than we might otherwise..??
-def parse_docstring(api_doc, docindex, supress_warnings=[]):
+def parse_docstring(api_doc, docindex, suppress_warnings=[]):
"""
Process the given C{APIDoc}'s docstring. In particular, populate
the C{APIDoc}'s C{descr} and C{summary} attributes, and add any
@@ -176,8 +176,8 @@
@param docindex: A DocIndex, used to find the containing
module (to look up the docformat); and to find any
user docfields defined by containing objects.
- @param supress_warnings: A set of objects for which docstring
- warnings should be supressed.
+ @param suppress_warnings: A set of objects for which docstring
+ warnings should be suppressed.
"""
if api_doc.metadata is not UNKNOWN:
if not (isinstance(api_doc, RoutineDoc)
@@ -231,7 +231,7 @@
initvar = api_doc.variables.get('__init__')
if initvar and isinstance(initvar.value, RoutineDoc):
init_api_doc = initvar.value
- parse_docstring(init_api_doc, docindex, supress_warnings)
+ parse_docstring(init_api_doc, docindex, suppress_warnings)
parse_function_signature(init_api_doc, api_doc,
docformat, parse_errors)
@@ -276,9 +276,9 @@
# vars/params?
# Report any errors that occured
- if api_doc in supress_warnings:
+ if api_doc in suppress_warnings:
if parse_errors or field_warnings:
- log.info("Supressing docstring warnings for %s, since it "
+ log.info("Suppressing docstring warnings for %s, since it "
"is not included in the documented set." %
api_doc.canonical_name)
else:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
