Skip to content

Commit

Permalink
Merge pull request #45 from daknuett/master
Browse files Browse the repository at this point in the history
added initial documentation for commands (for #44)
  • Loading branch information
jamescooke committed Oct 25, 2018
2 parents 61371ac + e561302 commit 68022c4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/commands.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Controlling flake8-aaa in-code
******************************

flake8-aaa can be controlled using some special comments in
your test code.

Explicitly marking blocks
=========================

One can set the act block explicitly using the ``# act``
comment. This is necessary when there is no assignment
possible.

Disabling flake8-aaa selectively
================================

When flake8-aaa finds the ``# noqa`` comment after the
function/method head it will ignore this function/method.


1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Welcome to Flake8-AAA's documentation

discovery
rules
commands

0 comments on commit 68022c4

Please sign in to comment.