Skip to content

Commit

Permalink
Fix rst checking
Browse files Browse the repository at this point in the history
  • Loading branch information
nat-n committed Jul 9, 2023
1 parent 51fcf76 commit eb24589
Show file tree
Hide file tree
Showing 6 changed files with 335 additions and 169 deletions.
16 changes: 8 additions & 8 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,11 @@ How to add a new feature

1. Create your branch from *development*

::
.. code-block:: bash
git fetch
git checkout origin/development
git checkout -b feature/my_new_feature
git fetch
git checkout origin/development
git checkout -b feature/my_new_feature
2. Create a pull request back to *development*

Expand All @@ -124,11 +124,11 @@ How to add a hot fix

1. Create your branch from *main*

::
.. code-block:: bash
git fetch
git checkout origin/main
git checkout -b feature/my_new_feature
git fetch
git checkout origin/main
git checkout -b feature/my_new_feature
2. Create a pull request back to *main*, and one to *development*

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/help_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can add help text to your tasks by adding the ``help`` option to the task de
This help text will be displayed alongside the task name in the list of configured tasks when ``poe`` is run without specifying a task.

.. code-block::
.. code-block:: docs
$ poe --help
Poe the Poet - A task runner that works well with poetry.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/library_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following script replicates the main functionality of the `poe` standalone c
if __name__ == "__main__":
app = PoeThePoet()
result = app(cli_args=sys.argv[1:]
result = app(cli_args=sys.argv[1:])
if result:
sys.exit(result)
Expand Down
9 changes: 3 additions & 6 deletions docs/tasks/task_types/expr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The expression can reference environment variables using templating syntax as in
)"""
args = [{ name = "target-venv", default = ".venv", positional = true }]
.. code-block::
.. code-block:: sh
$ poe venv-active poethepoet-LCpCQf8S-py3.10
Poe => (
Expand All @@ -65,12 +65,9 @@ The expression can reference environment variables using templating syntax as in
)
poethepoet-LCpCQf8S-py3.10 is not active
In this example the :code:`VIRTUAL_ENV` environment variable is templated into the
expression using the usual templating syntax, and the :code:`target_venv` argument is
referenced directly as a variable.
In this example the ``VIRTUAL_ENV`` environment variable is templated into the expression using the usual templating syntax, and the ``target_venv`` argument is referenced directly as a variable.
Notice that the expression may be formatted over multiple lines, as in normal python
code.
Notice that the expression may be formatted over multiple lines, as in normal python code.
Referencing imported modules in an expression
Expand Down
Loading

0 comments on commit eb24589

Please sign in to comment.