asweigart/pyinputplus

inputPassword docstring refers to parameters and constraints not yet present

Opened this issue · 1 comments

This is not critical or urgent.

The docstring for inputPassword includes:

  • "If correctPassword is None, then any input is accepted and returned by inputPassword()"
  • "By default, limit is set to 1, so an incorrect password attempt results in raising RetryLimitException."
  • "The wrongPasswordMsg string is displayed whenever the user enters an incorrect password."

However, the function does not yet have parameters correctPassword or wrongPasswordMsg, and I do not see a place that sets the default limit to 1.

This issue is over-eager, because the file acknowledges inputPassword is incomplete.
Line 1516 notes

# TODO - Finish the following

and the definition for inputPassword occurs below that line.