asweigart / asweigart/pyinputplus

inputName() not shown in docs

Open
#18 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

When using pyinputplus in VS Code, Intellisense shows an option for inputName():

(prompt: str = "", default: Any | None = None, blank: bool = False, timeout: float | None = None, limit: int | None = None, strip: str | bool | None = None, allowRegexes: Sequence[Pattern | str] | None = None, blockRegexes: Sequence[Pattern | str | Sequence[Pattern | str]] | None = None, applyFunc: (*args, **kwargs) -> Any | None = None, postValidateApplyFunc: (*args, **kwargs) -> Any | None = None) -> Any

But I can't find any references to same on the pages on pypi or readthedocs.io

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the project documentation and source for inputName() to identify where its public API is documented. Add the missing inputName() reference and verify that the documentation describes the exposed signature and usage.

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.