QUERY · ISSUE

Documentation WLAN.connect()

openby karfasopened 2021-05-03updated 2025-11-06

docs

In https://docs.micropython.org/en/latest/wipy/tutorial/wlan.html, the connect() method reads
wlan.connect(net.ssid, auth=(net.sec, 'mywifikey'), timeout=5000)

In contrary, https://docs.micropython.org/en/latest/library/network.WLAN.html?highlight=wlan#network.WLAN.connect describes the connect() call as
WLAN.connect(ssid=None, password=None, *, bssid=None)

Which one is the correct/current one (and for which port ?) ?
This is quite confusing for new users, I think.

CANDIDATE · PULL REQUEST

doc: make wifi/wlan naming consistent with tutorial.rst

closedby zsquarepluscopened 2015-11-10updated 2015-11-18

tutorial and quickref use a different variable name which makes it harder-than-need to combine example code

Assessment

Q Qwen · medium

The query (issue #7207) asks about the correct signature of WLAN.connect() and the confusion between different documentation sources (WiPy tutorial vs generic library docs). The candidate (PR #1612) addresses documentation consistency by renaming 'wifi' to 'wlan' in WiPy quickref examples to match the tutorial. While both items concern WLAN documentation and WiPy, the PR focuses on variable naming consistency in examples rather than clarifying the actual method signature differences or resolving the confusion about which parameters are correct. The PR does not directly address the core question about the correct API signature.

Suggested action

Keep both items open. The PR improves documentation consistency but does not resolve the underlying confusion about API differences between ports. Consider linking the PR to the issue for context, but the issue may need further investigation or a separate documentation fix to clarify the signature differences.

Documentation WLAN.connect()

doc: make wifi/wlan naming consistent with tutorial.rst

Keyboard