Skip to content

Added doctests and docstrings#10712

Closed
FEROS01 wants to merge 2 commits intoTheAlgorithms:masterfrom
FEROS01:Feros_branch
Closed

Added doctests and docstrings#10712
FEROS01 wants to merge 2 commits intoTheAlgorithms:masterfrom
FEROS01:Feros_branch

Conversation

@FEROS01
Copy link
Copy Markdown
Contributor

@FEROS01 FEROS01 commented Oct 19, 2023

Describe your change:

Contributes to #9943"

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

Checklist:

  • [ x] I have read CONTRIBUTING.md.
  • [ x] This pull request is all my own work -- I have not plagiarized.
  • [ x] I know that pull requests will not be merged if they fail the automated tests.
  • [ x] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [ x] All new Python files are placed inside an existing directory.
  • [ x] All filenames are in all lowercase characters with no spaces or dashes.
  • [ x] All functions and variable names follow Python naming conventions.
  • [ x] All function parameters and return values are annotated with Python type hints.
  • [ x] All functions have doctests that pass the automated testing.
  • [ x] All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • [ x] 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
Copy link
Copy Markdown

algorithms-keeper bot commented Oct 19, 2023

Closing this pull request as invalid

@FEROS01, this pull request is being closed as none of the checkboxes have been marked. It is important that you go through the checklist and mark the ones relevant to this pull request. Please read the Contributing guidelines.

If you're facing any problem on how to mark a checkbox, please read the following instructions:

  • Read a point one at a time and think if it is relevant to the pull request or not.
  • If it is, then mark it by putting a x between the square bracket like so: [x]

NOTE: Only [x] is supported so if you have put any other letter or symbol between the brackets, that will be marked as invalid. If that is the case then please open a new pull request with the appropriate changes.

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 19, 2023
@FEROS01
Copy link
Copy Markdown
Contributor Author

FEROS01 commented Oct 19, 2023

Hello, I am new here. My branch is not being merged because it failed the ruff test. The ruff test keeps saying "line too long", but I need to write long lines because one of the variables for the function I wrote a doctest for, requires a long dictionary. If I share the dictionary into different lines the doctest fails.

imSanko
imSanko reviewed Oct 20, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@imSanko imSanko left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just follow the https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@imSanko imSanko imSanko left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed invalid

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@FEROS01 @imSanko