Skip to content

Add docstring to prompt() - #15092

Merged
cclauss merged 6 commits into
TheAlgorithms:masterfrom
Jarvis-J-Jacob:docs-prompt-docstring
Sep 8, 2026
Merged

Add docstring to prompt()#15092
cclauss merged 6 commits into
TheAlgorithms:masterfrom
Jarvis-J-Jacob:docs-prompt-docstring

Conversation

@Jarvis-J-Jacob

@Jarvis-J-Jacob Jarvis-J-Jacob commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Describe your change:

The prompt() function had no docstring, so it wasn't clear what it did.
Add a docstring to give explanation for prompt.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Aug 27, 2026
@Jarvis-J-Jacob

Copy link
Copy Markdown
Contributor Author

Merge docstring to prompt()

@algorithms-keeper algorithms-keeper Bot added tests are failing Do not merge until tests pass labels Sep 8, 2026
Updated prompt function to accept width parameter and modified example outputs accordingly.
@algorithms-keeper algorithms-keeper Bot removed the tests are failing Do not merge until tests pass label Sep 8, 2026
@algorithms-keeper algorithms-keeper Bot removed the awaiting reviews This PR is ready to be reviewed label Sep 8, 2026
@cclauss
cclauss merged commit 9b029f6 into TheAlgorithms:master Sep 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement This PR modified some existing files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants