Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstrings and doctests and fix a bug ciphers/trifid_cipher.py #10716

Merged
merged 15 commits into from
Oct 20, 2023
Merged

Add docstrings and doctests and fix a bug ciphers/trifid_cipher.py #10716

merged 15 commits into from
Oct 20, 2023

Conversation

FEROS01
Copy link
Contributor

@FEROS01 FEROS01 commented Oct 20, 2023

Describe your change:

Contributes to #9943

  • 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.

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 Oct 20, 2023
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 20, 2023
cclauss
cclauss reviewed Oct 20, 2023
View reviewed changes
cclauss
cclauss reviewed Oct 20, 2023
View reviewed changes
@cclauss cclauss changed the title Added docstrings doctests and fixed a bug Add docstrings and doctests and fix a bug ciphers/trifid_cipher.py Oct 20, 2023
FEROS01 and others added 3 commits October 20, 2023 15:00
@FEROS01 @cclauss
Update ciphers/trifid_cipher.py
27b63be 
Co-authored-by: Christian Clauss <cclauss@me.com>
@FEROS01 @cclauss
Update ciphers/trifid_cipher.py
b3511bf 
Co-authored-by: Christian Clauss <cclauss@me.com>
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
e28f430 
for more information, see https://pre-commit.ci
@algorithms-keeper algorithms-keeper bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Oct 20, 2023
@cclauss
Copy link
Member

cclauss commented Oct 20, 2023

Just two characters... ;-)

ruff --output-format=github .
Error: ciphers/trifid_cipher.py:45:89: E501 Line too long (90 > 88 characters)

@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 20, 2023
cclauss
cclauss approved these changes Oct 20, 2023
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Nice one! Thanks.

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 20, 2023
@cclauss cclauss merged commit 52a987e into TheAlgorithms:master Oct 20, 2023
@FEROS01 FEROS01 deleted the feros001_branch branch October 21, 2023 00:36
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@FEROS01 @pre-commit-ci
@cclauss @sedatguzelsemme
Add docstrings and doctests and fix a bug ciphers/trifid_cipher.py (T…
01be4f0 
…heAlgorithms#10716)

* Added docstrings,doctests and fixed a bug

* Added docstrings,doctests and fixed a bug

* Added docstrings,doctests and fixed a bug

* Added docstrings and doctests with a bug fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added docstrings and doctests with a bug fix

* Update ciphers/trifid_cipher.py

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update ciphers/trifid_cipher.py

Co-authored-by: Christian Clauss <cclauss@me.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Docstrings edit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update trifid_cipher.py

* Update pyproject.toml

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@FEROS01 @cclauss