Added docstring for documentation and usage example

This commit is contained in:
Logan Lipke
2020-12-30 16:53:34 -08:00
parent 8b2d5ce0de
commit 7c4789b673
5 changed files with 80 additions and 32 deletions

View File

@@ -1,5 +1,13 @@
#!/usr/bin/env python3
"""
Script for creating a variable number of stations and attempting to connect them to an SSID using IPv6.
A test will run to verify stations are associated and get an IP, if these conditions are both true, the test will
pass, otherwise, the test will fail.
Use './test_ipv6_connection.py --help' to see command line usage and options
"""
import sys
import os
if sys.version_info[0] != 3:
@@ -129,7 +137,7 @@ def main():
''',
description='''\
test_ipv6_connection.py:
test_ipv6_connection.py:
--------------------------------------------------
Generic command example:
python3 ./test_ipv6_connection.py