From 6a40619b768d13143d63b062ae02fdb620ae5e43 Mon Sep 17 00:00:00 2001
From: bleudev <spdd5724@gmail.com>
Date: Fri, 7 Jun 2024 22:19:52 +0300
Subject: [PATCH] final examples

---
 examples/ustack.md | 155 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 127 insertions(+), 28 deletions(-)

diff --git a/examples/ustack.md b/examples/ustack.md
index d02352d..d38e279 100644
--- a/examples/ustack.md
+++ b/examples/ustack.md
@@ -1,40 +1,139 @@
-# Getting started
-To start, install ufpy lib by command
-### Windows
+# UStack
+
+## Introduction
+
+UStack is list with possibility to get only top element with useful features. [Wiki](https://en.wikipedia.org/wiki/Stack_(abstract_data_type))
+
+Firstly, import `UStack` from `ufpy`
+```python
+from ufpy import UStack
+```
+
+## Create UStack
+
+For creating UStack you should use this code:
+```python
+s = UStack() # blank stack
+s = UStack(1, 9, 2) # You can also provide elements as arguments
+s = UStack(iterable=[9, 2, 8]) # Or with `iterable` kwarg
+```
+
+## Get / edit / delete top element
+
+For getting top element you can use `top` property:
+```python
+s.top
+```
+
+For editing, you can just set value to this property:
+```python
+s.top = 2
+```
+
+For deleting:
+```python
+del s.top
+```
+
+Also, you can use `pop()` method for deleting. On this way you also will get top element
+after its deleting. It's working how `list.pop()`:
+```python
+popped_element = s.pop()
+```
+
+If you want to delete several elements, use `remove()` method:
+```python
+s.remove(2, 9, 1) # delete first elements with values 2 or 9 or 1
+# (how list.remove(), but with several elements)
+```
+
+## Get / set / delete all elements
+
+You can get all elements with `elements` property:
+```python
+s.elements
+```
+
+Also with property you can edit elements:
+```python
+s.elements = [1, 2, 3]
+```
+
+And delete them:
+```python
+del s.elements
+```
+
+## Push elements
+
+To add elements to the stack, use `push()` method
+
+```python
+s.push(1, 2, 3, 4, 5)
 ```
-pip install ufpy
+
+## Math operations
+
+You can use 4 math operations with stacks: `+`, `-`, `*`, `/`. `+`, `-` append or
+remove items to stack. `*`, `/` multiply or divide these items. [See UDict example for
+more information.](udict.md#math-operations)
+
+```python
+s = s + [1, 2]
+# or
+s += 1, 2
+
+s = s - 1
+# or
+s -= 1
+
+s *= 2 # multiply by 2
+s /= 2 # divide by 2
 ```
-### Linux
+
+## Get length of stack
+
+You can get length of stack using `len()` function:
+```python
+len(s)
 ```
-sudo pip install ufpy
+
+## Check that stack is empty or not empty
+
+You can check that stack is empty using `is_empty()` method:
+```python
+s = UStack()
+s.is_empty() # True
 ```
-## Create stack
-To create stack, use UStack class.
+
+Also, you can use `if UStack` syntax for checking that stack is not empty
 ```python
-stack = UStack()
+s = UStack()
+if s:
+    print("Stack isn't empty!")
+else:
+    print("Stack is empty!")
+# out: Stack is empty!
 ```
-## Append element
-To add an element to the stack, use UStack.append([<element1>, <elementN, ...])
+
+## Use `repr()` function with stack
+
+You can use `repr()` with stacks. Because of it, you can print stacks:
 ```python
-stack.append(1, 2, 3, 4, 5)
+s = UStack(1, 9, 2)
+print(s) # s[1, 9, 2]
 ```
-## Get top element
-To get the top element, use UStack.top()
+
+## Copying of UStack
+
+You can use `copy()` method for copying `UStack`s:
 ```python
-print(stack.top())
-# 5
+s.copy()
 ```
-## Remove top element
-To get and remove the top element of the stack, use UStack.pop()
+
+You can also use `copy.copy()` function for copying `UStack`s:
 ```python
-print(stack.pop())
-# 5
-print(stack.top())
-# 4
+from copy import copy
+
+copy(s)
 ```
-## All methods
-| Name    | Args    |
-| ------- | ------- |
-| top     | null    |
-| append  | **items |
-| pop     | null    |
\ No newline at end of file