Skip to content

README Linting and Fixes. #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 13, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 39 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,43 +413,67 @@ Extension points
The following functions can be provided to main(), to load_tool(), or to the
executor to override or augment the listed behaviors.

executor(tool, job_order_object, **kwargs)
(Process, Dict[Text, Any], **Any) -> Tuple[Dict[Text, Any], Text]
executor
::

executor(tool, job_order_object, **kwargs)
(Process, Dict[Text, Any], **Any) -> Tuple[Dict[Text, Any], Text]

A toplevel workflow execution loop, should synchronously execute a process
object and return an output object.

makeTool(toolpath_object, **kwargs)
(Dict[Text, Any], **Any) -> Process
makeTool
::

makeTool(toolpath_object, **kwargs)
(Dict[Text, Any], **Any) -> Process

Construct a Process object from a document.

selectResources(request)
(Dict[Text, int]) -> Dict[Text, int]
selectResources
::

selectResources(request)
(Dict[Text, int]) -> Dict[Text, int]

Take a resource request and turn it into a concrete resource assignment.

versionfunc()
() -> Text
versionfunc
::

()
() -> Text

Return version string.

make_fs_access(basedir)
(Text) -> StdFsAccess
make_fs_access
::

make_fs_access(basedir)
(Text) -> StdFsAccess

Return a file system access object.

fetcher_constructor(cache, session)
(Dict[unicode, unicode], requests.sessions.Session) -> Fetcher
fetcher_constructor
::

fetcher_constructor(cache, session)
(Dict[unicode, unicode], requests.sessions.Session) -> Fetcher

Construct a Fetcher object with the supplied cache and HTTP session.

resolver(document_loader, document)
(Loader, Union[Text, dict[Text, Any]]) -> Text
resolver
::

resolver(document_loader, document)
(Loader, Union[Text, dict[Text, Any]]) -> Text

Resolve a relative document identifier to an absolute one which can be fetched.

logger_handler
logging.Handler
::

logger_handler
logging.Handler

Handler object for logging.
7 changes: 6 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = py27-lint, py27-unit, py27-pipconflictchecker, py36-lint, py35-lint, py34-lint, py33-lint, py35-mypy2
envlist = py27-lint, py27-unit, py27-pipconflictchecker, py36-lint, py35-lint, py34-lint, py33-lint, py35-mypy2, py27-lint-readme
skipsdist = True

[travis]
Expand Down Expand Up @@ -36,3 +36,8 @@ deps = pip-conflict-checker

[testenv:py27-unit]
commands = python setup.py test

[testenv:py27-lint-readme]
commands = python setup.py check -r -s
deps =
readme