Unassigned string statement PYL-W0105
Anti-pattern
Minor
2 years ago
—
2 years old
String statement has no effect
1#!/usr/bin/env python
2"""SRE regex tools."""
3
4""" 5Copyright 2020 John Vandenberg
6
7Licensed under the Apache License, Version 2.0 (the "License");
Description
The string statement has not been assigned to anything. This is pointless and should be removed if not necessary. In case this is supposed to describe what's happening in the code, it is recommended to use comments or docstrings instead.
Not preferred:
'Define a function to add 2 numbers here.'
def add(a, b):
return a + b
Preferred:
Use Comments:
# Define a function to add 2 numbers here.
def add(a, b):
return a + b
or, use docstrings:
def add(a, b):
'''Function to add 2 numbers here.'''
return a + b