Skip to content

added simplifying comments #6502

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
Closed
wants to merge 8 commits into from
Closed

added simplifying comments #6502

wants to merge 8 commits into from

Conversation

advik-student-dev
Copy link
Contributor

@advik-student-dev advik-student-dev commented Oct 2, 2022 •
edited
Loading

Describe your change:

added some comments to make the code reader able to visualise the equations (i.e write the equations in an algebraic manner so that another programmer will know the exact equation). not added comments like this to all of the calcs

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@advik-student-dev
added simplifying comments
bb74ff3 
added some comments to make the code reader able to visualise the equations (i.e write the equations in an algebraic manner so that another programmer will know the exact equation). not added comments like this to all of the calcs
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Oct 2, 2022
@advik-student-dev
Copy link
Contributor Author

idk what doctests are

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 2, 2022
CaedenPH
CaedenPH reviewed Oct 2, 2022
View reviewed changes
Copy link
Contributor

@CaedenPH CaedenPH left a comment

Choose a reason for hiding this comment

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

In my opinion, some of the comments look a bit messy, for example the cube one - It is way too long, you may want to add a line break

@advik-student-dev
Copy link
Contributor Author

Thanks for suggestions! Have he suggestions been committed now I. The pull request?

advik-student-dev
advik-student-dev commented Oct 2, 2022
View reviewed changes
Copy link
Contributor Author

@advik-student-dev advik-student-dev left a comment

Choose a reason for hiding this comment

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

line 26 length reduced

@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 2, 2022
@algorithms-keeper algorithms-keeper bot added the merge conflicts Open a new PR or rebase on the latest commit label Oct 13, 2022
@algorithms-keeper algorithms-keeper bot mentioned this pull request Oct 13, 2022
Closed
14 tasks
@algorithms-keeper algorithms-keeper bot removed the merge conflicts Open a new PR or rebase on the latest commit label Oct 14, 2022
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CaedenPH CaedenPH CaedenPH left review comments

@Kush1101 Kush1101 Awaiting requested review from Kush1101

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files tests are failing Do not merge until tests pass
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@advik-student-dev @CaedenPH