Skip to content

[fix/docs]: Improve data_structures/linked_list.cpp #999

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
Merged
Panquesito7 merged 71 commits into from
Sep 4, 2020
Merged

[fix/docs]: Improve data_structures/linked_list.cpp #999

Panquesito7 merged 71 commits into from
Sep 4, 2020

Conversation

@techievert
Copy link
Contributor

@techievert techievert commented Aug 9, 2020 •
edited by Panquesito7
Loading

Description of Change

Checklist

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Added documentation so that the program is self-explanatory and educational - Doxygen guidelines
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes:

techievert and others added 5 commits August 5, 2020 16:57
@techievert
Addition of Test to LinkedList
c46c6ef 
I noticed an infinite loop when the program asks the user to "Enter the element to be inserted:", and the user enters a wrong input such as "rr".
@techievert
Revised Tests
7ccd544
@techievert
Update linked_list.cpp
e149a35
@techievert
Update linked_list.cpp
9d35b08
@techievert
Update linked_list.cpp
8517870
@techievert techievert closed this Aug 9, 2020
@techievert techievert reopened this Aug 9, 2020
Panquesito7
Panquesito7 requested changes Aug 9, 2020
View reviewed changes
Copy link
Member

@Panquesito7 Panquesito7 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.

By the way, what is the vdoubly_linked_list.ico file for?
techievert and others added 10 commits August 10, 2020 00:44
@techievert @Panquesito7
Update data_structures/linked_list.cpp
e2ddd3a 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
10ce51a 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
ceaa185 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
e14465b 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
7ede1e7 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
4094e54 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert @Panquesito7
Update data_structures/linked_list.cpp
6ee4724 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert
Update linked_list.cpp
5f83fac
@techievert
Update linked_list.cpp
5c7e289
@techievert
Update linked_list.cpp
dcff7b0
Panquesito7
Panquesito7 requested changes Aug 10, 2020
View reviewed changes
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

Looks much better, good work updating the codes. 👍
Now, the next thing to do is to add documentation to all functions:

  • Parameters
  • Return statements
  • Brief description

Confused? See #962 as a reference.
@Panquesito7
Copy link
Member

Panquesito7 commented Aug 10, 2020

Also, next time, don't open a new PR (older PR: #989).
Update the same PR and it'll be easier to review.
@Panquesito7 Panquesito7 added Improvement improvement in previously written codes requested changes changes have been requested labels Aug 10, 2020
@Panquesito7
Copy link
Member

Panquesito7 commented Aug 10, 2020

Please follow these commit guidelines.
It gives a brief description of what the commit does.
techievert and others added 3 commits August 10, 2020 18:56
@techievert @Panquesito7
Update data_structures/linked_list.cpp
835b14c 
Co-authored-by: David Leal <halfpacho@gmail.com>
@techievert
added documentations to functions
5512600 
I made a few changes although I'm not sure I covered all.
@techievert
Update linked_list.cpp
5e00ffa
@techievert
Copy link
Contributor Author

techievert commented Aug 29, 2020

It just worked. I apologize for the inconvenience.
kvedala
kvedala requested changes Aug 29, 2020
View reviewed changes
Copy link
Collaborator

@kvedala kvedala 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.

much better. 👍

  1. some of the above suggestions are yet to be done. It might be convenient to mark the fixed suggestions as "resolved" so that you can work on those that are not resolved. For example, #999 (comment)
  2. please review the notes below.
@techievert
Copy link
Contributor Author

techievert commented Aug 31, 2020

Any additions?
@kvedala
Copy link
Collaborator

kvedala commented Aug 31, 2020 •
edited
Loading

Thank you. Please review the file once more by yourself and check for:

  1. undocumented functions - already pointed out above [fix/docs]: Improve data_structures/linked_list.cpp #999 (comment) and [fix/docs]: Improve data_structures/linked_list.cpp #999 (review)
  2. [fix/docs]: Improve data_structures/linked_list.cpp #999 (comment) is unaddressed

Once the fixes are made, we will execute the code using the GitPod link above before merging.
@techievert techievert closed this Aug 31, 2020
@techievert techievert reopened this Sep 2, 2020
@techievert techievert requested a review from kvedala September 2, 2020 22:51
@kvedala
Copy link
Collaborator

kvedala commented Sep 3, 2020

image
kvedala
kvedala approved these changes Sep 3, 2020
View reviewed changes
Copy link
Collaborator

@kvedala kvedala left a comment

Choose a reason for hiding this comment

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

👍 Kudos on your persistence and dedication. Thank you
@techievert
Copy link
Contributor Author

techievert commented Sep 3, 2020

Thank you.
Panquesito7
Panquesito7 approved these changes Sep 4, 2020
View reviewed changes
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

LGTM; great job! 😄 👍
@Panquesito7 Panquesito7 merged commit 6e77f98 into TheAlgorithms:master Sep 4, 2020
@Panquesito7 Panquesito7 changed the title Revised Linked List [fix/docs]: Improve data_structures/linked_list.cpp Sep 4, 2020
@techievert
Copy link
Contributor Author

techievert commented Sep 4, 2020

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

Labels

approved Approved; waiting for merge Improvement improvement in previously written codes

4 participants

@techievert @Panquesito7 @kvedala @ayaankhan98