From 514a9ebc252f0a6028bc357bba079cbee134ef5a Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Wed, 20 Feb 2019 12:10:12 +0100
Subject: [PATCH] [doc] Re-enable nitpicky mode; Fix broken docs
---
beat/backend/python/dataformat.py | 2 +-
beat/backend/python/execution/loop.py | 6 +++---
beat/backend/python/execution/messagehandlers.py | 9 +++++----
doc/conf.py | 5 +++--
4 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/beat/backend/python/dataformat.py b/beat/backend/python/dataformat.py
index be16bb2..88548a8 100644
--- a/beat/backend/python/dataformat.py
+++ b/beat/backend/python/dataformat.py
@@ -119,7 +119,7 @@ class DataFormat(object):
storage (object): A simple object that provides information about file
paths for this dataformat
- errors (list of str): A list containing errors found while loading this
+ errors (list): A list strings containing errors found while loading this
dataformat.
data (dict): The original data for this dataformat, as loaded by our JSON
diff --git a/beat/backend/python/execution/loop.py b/beat/backend/python/execution/loop.py
index c3bb69b..ee99c12 100644
--- a/beat/backend/python/execution/loop.py
+++ b/beat/backend/python/execution/loop.py
@@ -71,8 +71,8 @@ class LoopChannel(object):
""" Setup the channel internals
Parameters:
- algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
- the communication channel is setup.
+ algorithm (:py:class:`.algorithm.Algorithm`) : algorithm for which
+ the communication channel is setup.
prefix (str) : Folder were the prefix is located.
"""
@@ -89,7 +89,7 @@ class LoopChannel(object):
Parameters:
hypothesis (dict) : Computed hypothesis that must be validated by
- the loop algorithm.
+ the loop algorithm.
"""
data = make_data_format(hypothesis, self.request_data_format)
diff --git a/beat/backend/python/execution/messagehandlers.py b/beat/backend/python/execution/messagehandlers.py
index 655a2ed..aa34ea5 100644
--- a/beat/backend/python/execution/messagehandlers.py
+++ b/beat/backend/python/execution/messagehandlers.py
@@ -348,8 +348,8 @@ class LoopMessageHandler(MessageHandler):
""" Setup the loop internals
Parameters:
- algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
- the communication channel is setup.
+ algorithm (:py:class:`.algorithm.Algorithm`) : algorithm for which
+ the communication channel is setup.
prefix (str) : Folder were the prefix is located.
"""
@@ -364,7 +364,7 @@ class LoopMessageHandler(MessageHandler):
""" Set the executor for validation
Parameters:
- executor (:py:class:`.Executor`) : Loop executor
+ executor (:py:class:`.loop.LoopExecutor`) : Loop executor
"""
self.executor = executor
@@ -376,7 +376,8 @@ class LoopMessageHandler(MessageHandler):
Syntax: val
Parameters:
- result (:py:class:`dataformat.DataFormat`) : Result to be validated.
+ result (:py:class:`beat.backend.python.dataformat.DataFormat`) :
+ Result to be validated.
"""
result = result.encode("utf-8")
diff --git a/doc/conf.py b/doc/conf.py
index e14757c..4f1105f 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -30,7 +30,7 @@ extensions = [
]
# Be picky about warnings
-nitpicky = False
+nitpicky = True
# Ignores stuff we can't easily resolve on other project's sphinx manuals
nitpick_ignore = []
@@ -257,7 +257,8 @@ def member_function_test(app, what, name, obj, skip, options):
if len(name) > 1 and name[0] == '_':
# test if this private function should be allowed
if name not in accepted_private_functions:
- # omit privat functions that are not in the list of accepted private functions
+ # omit private functions that are not in the list of accepted private
+ # functions
return skip
else:
# test if the method is documented
--
GitLab