Skip to content

Commit 96a6d0e

Browse files
committed
fix docstrings
1 parent 7753ec0 commit 96a6d0e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

adafruit_httpserver/request.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ def _add_field_value(self, field_name: str, value: Union[str, bytes]) -> None:
3535

3636
@staticmethod
3737
def _html_output_encode(value):
38+
"""Encodes unsafe HTML characters."""
3839
return (
3940
str(value)
4041
.replace("&", "&")
@@ -46,7 +47,7 @@ def _html_output_encode(value):
4647

4748
@staticmethod
4849
def _debug_warning_nonencoded_output():
49-
"""Warns about exposing all files on the device."""
50+
"""Warns about XSS risks."""
5051
print(
5152
"WARNING: Setting html_output_encode to False makes XSS vulnerabilities possible by "
5253
"allowing access to raw untrusted values submitted by users. If this data is reflected "

0 commit comments

Comments
 (0)