Skip to content

Commit

Permalink
documentation: Added documentation for the violation RawStringNotNeed…
Browse files Browse the repository at this point in the history
…edViolation (WPS357). Follows the general structure for documentation.

Relates to original issue wemake-services#1081. Closes #11
  • Loading branch information
fwald authored and Mema5 committed Feb 24, 2020
1 parent 358f852 commit 4dea657
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions wemake_python_styleguide/violations/consistency.py
Expand Up @@ -82,11 +82,8 @@
ConsecutiveYieldsViolation
BracketBlankLineViolation
IterableUnpackingViolation
<<<<<<< HEAD
LineCompriseCarriageReturnViolation
=======
RawStringNotNeededViolation
>>>>>>> feat: added the new violation to be completed, closes #7
Consistency checks
------------------
Expand Down Expand Up @@ -148,11 +145,8 @@
.. autoclass:: ConsecutiveYieldsViolation
.. autoclass:: BracketBlankLineViolation
.. autoclass:: IterableUnpackingViolation
<<<<<<< HEAD
.. autoclass:: LineCompriseCarriageReturnViolation
=======
.. autoclass:: RawStringNotNeededViolation
>>>>>>> feat: added the new violation to be completed, closes #7
"""

Expand Down Expand Up @@ -2133,7 +2127,6 @@ class IterableUnpackingViolation(ASTViolation):


@final
<<<<<<< HEAD
class LineCompriseCarriageReturnViolation(TokenizeViolation):
r"""
Forbids to use ``\r`` (carriage return) in line breaks.
Expand All @@ -2151,23 +2144,21 @@ class LineCompriseCarriageReturnViolation(TokenizeViolation):
"""

error_template = r'Found a ``\r`` (carriage return) line break'
=======
code = 357


@final
class RawStringNotNeededViolation(TokenizeViolation):
"""
Summary here.
Reasoning:
Reasoning here.
Solution:
Solution here.
Example::
Examples here.
.. versionadded:: 0.13.0
"""

error_template = 'Error template here'
>>>>>>> feat: added the new violation to be completed, closes #7
code = 357
code = 358

0 comments on commit 4dea657

Please sign in to comment.