Skip to content

Delete base85 algorithm #8965

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.

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

Closed
wants to merge 2 commits into from
Closed

Conversation

CaedenPH
Copy link
Contributor

@CaedenPH CaedenPH commented Aug 16, 2023

Describe your change:

Re #6216

Normally, I'm not in favour of just deleting algorithms, but I would make the argument that this is not an algorithm, rather just a snippet of code that utilises another library.

Per CONTRIBTUING.md

Algorithms in this repo should not be how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values
This base85 algorithm has essentially got two lines of code that purely utilise a singular library. The doctests only test an external library

This repository should not contains examples on how to use a certain library, that would be the library documentation here
https://docs.python.org/3/library/base64.html

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?
  • Delete an algorithm

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

@CaedenPH
Copy link
Contributor Author

CaedenPH commented Aug 16, 2023

@tianyizheng02 Opinion?

Will also create a pr to delete
https://github.com/TheAlgorithms/Python/blob/master/ciphers/base32.py

However, I like the base16 and the base64 because they actually use calculations, not a library

Also very open to further implementations of base32 and base85, just an actual algorithm that does not solely use a library

@tianyizheng02
Copy link
Contributor

Obviously I agree that we can't have this "algorithm" simply utilize a library, but personally I'd rather we keep the file around and encourage other contributors to reimplement the algorithm instead. Unless one of us reimplements the algorithm right after this file is deleted, there's no guarantee that someone else will contribute the same algorithm again. Having the file around could at least serve as a reminder of an ongoing issue.

@ChrisO345 ChrisO345 mentioned this pull request Sep 20, 2023
14 tasks
@CaedenPH CaedenPH mentioned this pull request Sep 20, 2023
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants