Housekeeping #93
Housekeeping #93
Conversation
rnixx
commented
Dec 20, 2017
rnixx
commented
- Close open file descriptors in setup.py
- Some cleanup in restructured text files
docs/install/index.rst
Outdated
| For a standalone usage: | ||
|
|
||
| .. code:: bash | ||
| .. code-block:: shell |
There was a problem hiding this comment.
please use console instead of shell as this is a console session block see: http://pygments.org/docs/lexers/#lexers-for-various-shells
|
|
||
| Technical Backgrounds - Links to External Documentation | ||
| --------------------------------------------------------- | ||
| ....................................................... |
There was a problem hiding this comment.
why a level-change of the headings?
There was a problem hiding this comment.
because it looked like "Technical Backgrounds" is a subsection of "Modifying the AST"
docs/usage/basic_usage.rst
Outdated
| The general workflow to execute Python code that is loaded within a Python program is: | ||
|
|
||
| .. testcode:: | ||
| .. code-block:: python |
There was a problem hiding this comment.
please do not change .. testcode:: derictives to code-block derictives, as this changes also the behaviour.
code-block only highlights the code,
testcode actualy allows to perform tests on that code
docs/usage/basic_usage.rst
Outdated
| With RestrictedPython that workflow should be as straight forward as possible: | ||
|
|
||
| .. testcode:: | ||
| .. code-block:: python |
docs/usage/basic_usage.rst
Outdated
| You might also use the replacement import: | ||
|
|
||
| .. testcode:: | ||
| .. code-block:: python |
docs/usage/framework_usage.rst
Outdated
| A policy is basically a special ``NodeTransformer`` that could be instantiated with three params for ``errors``, ``warnings`` and ``used_names``, it should be a subclass of RestrictedPython.RestrictingNodeTransformer. | ||
|
|
||
| .. testcode:: own_policy | ||
| .. code-block:: python |
There was a problem hiding this comment.
same, keep testcode
please also look at the [group] element of sphinx.ext.doctest the group name defines a context and all tests in this group context are evaluated together.
docs/usage/framework_usage.rst
Outdated
| All ``compile_restricted*`` methods do have a optional parameter ``policy``, where a specific policy could be provided. | ||
|
|
||
| .. testcode:: own_policy | ||
| .. code-block:: python |
docs/usage/framework_usage.rst
Outdated
| That special case would be written as: | ||
|
|
||
| .. testcode:: | ||
| .. code-block:: python |
| ... ''' | ||
| >>> from RestrictedPython import compile_restricted | ||
| >>> code = compile_restricted(src, '<string>', 'exec') | ||
| .. code-block:: pycon |
There was a problem hiding this comment.
could that be a doctest derictive? it is not in sphinx context
There was a problem hiding this comment.
you mean .. code-block:: doctest?
pycon also works well if you view on github. But i can of course change if you want.
There was a problem hiding this comment.
pycon is the lexer used by pygments, so just highlighting, I meant replacing code-block:: with doctest::
| your restrictions. A usable "safe" set is | ||
| ``RestrictedPython.Guards.safe_builtins``. | ||
|
|
||
| To help illustrate how this works under the covers, here's an example |
There was a problem hiding this comment.
please do not break documentation lines wthin sentences.
There was a problem hiding this comment.
line breaks within sentences are in there all over the place. What's the reason for this policy?
3 participants
