asweigart / asweigart/pyinputplus

inputPassword docstring refers to parameters and constraints not yet present

Open
#31 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
114
Forks
19
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the `inputPassword` definition and read its docstring alongside the function signature and behavior. Determine whether the documented parameters and default `limit` should be corrected or implemented; done means the documentation accurately matches the supported interface and behavior, with relevant tests run if available.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.