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.

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

Improved examples #123

Merged
merged 3 commits into from
Mar 5, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ PyDataStructs
[![Build Status](https://travis-ci.org/codezonediitj/pydatastructs.png?branch=master)](https://travis-ci.org/codezonediitj/pydatastructs) [![Join the chat at https://gitter.im/codezonediitj/pydatastructs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/codezoned2017/Lobby) [![Discuss at pydatastructs@googlegroups.com](https://img.shields.io/badge/discuss-pydatastructs%40googlegroups.com-blue.svg)](https://groups.google.com/forum/#!forum/pydatastructs) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/codezonediitj/pydatastructs/pulls) [![codecov](https://codecov.io/gh/codezonediitj/pydatastructs/branch/master/graph/badge.svg)](https://codecov.io/gh/codezonediitj/pydatastructs)

About
-----------
-----

Currently, the aim of the project is to be a Python package for various data structures in computer science. In addition, we are also working on including parallel algorithms. To the best of our knowledge a well designed library/package which has covered most of the data structures and algorithms including their parallel implementation doesn't exist.
Currently, the project aims to be a Python package for various data structures in computer science. Besides, we are also working on including parallel algorithms. To the best of our knowledge, a well-designed library/package which has covered most of the data structures and algorithms including their parallel implementation doesn't exist.

In future, i.e, after a few releases of the package when the software design will become stable, we also aim to provide APIs for the code in C++ and Java as well.

Expand All @@ -19,7 +19,7 @@ You can install the library by running the following command,
python3 setup.py install
```

For development purposes you can use the option `develop` as shown below,
For development purposes, you can use the option `develop` as shown below,

```python
python3 setup.py develop
Expand Down Expand Up @@ -57,7 +57,7 @@ Follow the steps given below,
8. Execute, `git add .`.
9. Execute, `git commit -m "your-commit-message"`.
10. Execute, `git push origin_user <your-current-branch>`.
11. Make a PR.
11. Make PR.

That's it, 10 easy steps for your first contribution. For future contributions just follow steps 5 to 10. Make sure that before starting work, always checkout to master and pull the recent changes using the remote `origin` and then start following steps 5 to 10.

Expand All @@ -66,7 +66,7 @@ See you soon with your first PR.
Guidelines
----------

We recommend you to introduce yourself on our [gitter channel](https://gitter.im/codezoned2017/Lobby). You can include the courses you have taken relevant to data structures and algorithms, some projects, prior experience, in your introduction. This will help us to allocate you issues of suitable difficulty.
czgdp1807 marked this conversation as resolved.
Show resolved Hide resolved
We recommend you to introduce yourself on our [gitter channel](https://gitter.im/codezoned2017/Lobby). You can include the courses you have taken relevant to data structures and algorithms, some projects, prior experience, in your introduction. This will help us to allocate your issues of suitable difficulty.
czgdp1807 marked this conversation as resolved.
Show resolved Hide resolved

Please follow the rules and guidelines given below,

Expand All @@ -79,6 +79,6 @@ The following parameters are to be followed to pass the code quality tests for y
1. There should not be any trailing white spaces at any line of code.
2. Each `.py` file should end with exactly one new line.
3. Comparisons involving `True`, `False` and `None` should be done by
reference(using `is`, `is not`) and not by value(`==`, `!=`).
reference (using `is`, `is not`) and not by value(`==`, `!=`).

Keep contributing!!
32 changes: 16 additions & 16 deletions pydatastructs/linear_data_structures/linked_lists.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ class DoublyLinkedList(LinkedList):
6
>>> dll.append(5)
>>> dll.append_left(2)
>>> print(dll)
[2, 6, 5]
>>> str(dll)
'[2, 6, 5]'
>>> dll[0].data = 7.2
>>> dll.extract(1).data
6
>>> print(dll)
[7.2, 5]
>>> str(dll)
'[7.2, 5]'
References
==========
Expand Down Expand Up @@ -306,13 +306,13 @@ class SinglyLinkedList(LinkedList):
6
>>> sll.append(5)
>>> sll.append_left(2)
>>> print(sll)
[2, 6, 5]
>>> str(sll)
'[2, 6, 5]'
>>> sll[0].data = 7.2
>>> sll.extract(1).data
6
>>> print(sll)
[7.2, 5]
>>> str(sll)
'[7.2, 5]'
References
==========
Expand Down Expand Up @@ -530,13 +530,13 @@ class SinglyCircularLinkedList(SinglyLinkedList):
6
>>> scll.append(5)
>>> scll.append_left(2)
>>> print(scll)
[2, 6, 5]
>>> str(scll)
'[2, 6, 5]'
>>> scll[0].data = 7.2
>>> scll.extract(1).data
6
>>> print(scll)
[7.2, 5]
>>> str(scll)
'[7.2, 5]'
References
==========
Expand Down Expand Up @@ -624,13 +624,13 @@ class DoublyCircularLinkedList(DoublyLinkedList):
6
>>> dcll.append(5)
>>> dcll.append_left(2)
>>> print(dcll)
[2, 6, 5]
>>> str(dcll)
'[2, 6, 5]'
>>> dcll[0].data = 7.2
>>> dcll.extract(1).data
6
>>> print(dcll)
[7.2, 5]
>>> str(dcll)
'[7.2, 5]'
References
==========
Expand Down