Verified Commit da5f65ad authored by Dom Sekotill's avatar Dom Sekotill
Browse files

Improve some docstrings

parent 9ed35a12

wpa_supplicant/client/base.py

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ 
#  limitations under the License.



"""

This module provides a base WPA-Supplicant client implementation

Base implementation for WPA-Supplicant client classes

"""



from __future__ import annotations

wpa_supplicant/client/interfaces.py

+4 −1
Original line number Diff line number Diff line
@@ -38,12 +38,15 @@ class InterfaceClient(BaseClient): 
	name = None



	async def connect(self, path: PathLike[str]) -> None:

		"""

		Connect to an interface UNIX port

		"""

		await super().connect(path)

		self.name = await self.send_command(consts.COMMAND_IFNAME, convert=str)



	async def scan(self) -> AsyncGenerator[StringMap, None]:

		"""

		Iteratively produces the details of all detectable IEEE 802.11 BSS

		Yield the details of all detectable IEEE 802.11 BSS



		(WiFi Access Points to you and me)

		"""