Sweep: correct "Documentation" section on README.md file, fill empty examples and missing description

[francescobianco]

Please, correct the "Documentation" section on README.md file. Fill in empty examples and missing description

Checklist

• Modify README.md ✓ dc1e60b Edit
• Running GitHub Actions for README.md ✓ Edit
• Modify README.md ▶ Edit
• Running GitHub Actions for README.md ▶ Edit

[francescobianco]

💎 Sweep Pro: I'm using GPT-4. You have unlimited GPT-4 tickets. (tracking ID: None)

---

Tip

I can email you when I complete this pull request if you set up your email here!

---

Actions (click)

• ↻ Restart Sweep

---

Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I think are relevant in decreasing order of relevance (click to expand). If some file is missing from here, you can mention the path in the ticket description.

pipetest/README.md

Lines 58 to 250 in e141919

	## Documentation
	There are the lists of supported functions
	- [**assert_empty**](#assert_empty) - Fails if piped output is not empty
	- [**assert_not_empty**](#assert_not_empty) - Fails if piped output is empty
	- [**assert_equals**](#assert_equals) - Fails if piped output not match with the argument
	- [**assert_not_equals**](#assert_not_equals) - Fails if piped output match with the argument
	- [**assert_starts_with**](#assert_starts_with) - Fails if piped output match with the argument
	- [**assert_each_line_starts_with**](#assert_each_line_starts_with) - Fails if piped output match with the argument
	- [**assert_ends_with**](#assert_ends_with) - Fails if piped output match with the argument
	- [**assert_each_line_ends_with**](#assert_ends_with) - Fails if piped output match with the argument
	- [**assert_match**](#assert_match) - Fails if piped output match with the argument
	- [**assert_file_exists**](#assert_file_exists) - Fails if piped file name as text not exists
	- [**assert_file_not_exists**](#assert_file_not_exists) - Fails if piped file name as text exists
	- [**assert_directory_exists**](#assert_directory_exists) -
	- [**assert_directory_not_exists**](#assert_directory_not_exists)
	<hr/>
	<div align="center">
	### `assert_empty`
	</div>
	Fails if piped output is not empty.
	**Usage**
	```bash
	... | assert_empty [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	echo "" | assert_empty
	```
	```bash
	ls | assert_empty "Current directory is not empty"
	```
	```bash
	cat apache2.log | assert_empty "Log file is not empty"
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>
	<hr/>
	### ➡ | `assert_empty`
	**Usage**
	```bash
	... | assert_empty [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	echo "" | assert_empty
	```
	```bash
	ls | assert_empty
	```
	```bash
	cat apache2.log | assert_empty
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>
	<hr/>
	### ➡ | `assert_file_exists`
	**Usage**
	```bash
	assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	touch sample_file.txt
	assert_file_exists sample_file.txt
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong."
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>
	<hr/>
	### ➡ | `assert_file_exists`
	**Usage**
	```bash
	assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	touch sample_file.txt
	assert_file_exists sample_file.txt
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong."
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>
	<hr/>
	### ➡ | `assert_file_exists`
	**Usage**
	```bash
	assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	touch sample_file.txt
	assert_file_exists sample_file.txt
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong."
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>
	<hr/>
	### ➡ | `assert_directory_exists`
	**Usage**
	```bash
	assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE]
	```
	**Examples**
	```bash
	touch sample_file.txt
	assert_file_exists sample_file.txt
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong."
	```
	```bash
	mv old_file_name.txt new_file_name.txt
	assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
	```
	<div align="right"><a href="#documentation">[back to top]</a></div>

---

Step 2: ⌨️ Coding

• Modify README.md ✓ dc1e60b Edit

Modify README.md with contents:
• Remove the duplicate sections for `assert_file_exists` that start at lines 166 and 195.
• This will correct the redundancy in the documentation.

--- 
+++ 
@@ -161,6 +161,15 @@
 
 
[back to top]
 
+
+
+```bash
+mv old_file_name.txt new_file_name.txt
+assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
+```
+
+
[back to top]
+
 

 
 ### ➡ | `assert_file_exists`
@@ -178,21 +187,13 @@
 assert_file_exists sample_file.txt
 ```
 
-```bash
-mv old_file_name.txt new_file_name.txt
-assert_file_exists new_file_name.txt "Moving file goes wrong."
-```
-
-```bash
-mv old_file_name.txt new_file_name.txt
-assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
-```
-
-
[back to top]
-
-

-
-### ➡ | `assert_file_exists`
+
+
+
[back to top]
+
+

+
+### ➡ | `assert_directory_exists`
 
 **Usage**
 
@@ -221,35 +222,6 @@
 
 

 
-### ➡ | `assert_directory_exists`
-
-**Usage**
-
-```bash
-assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE]
-```
-
-**Examples**
-
-```bash
-touch sample_file.txt
-assert_file_exists sample_file.txt
-```
-
-```bash
-mv old_file_name.txt new_file_name.txt
-assert_file_exists new_file_name.txt "Moving file goes wrong."
-```
-
-```bash
-mv old_file_name.txt new_file_name.txt
-assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working."
-```
-
-
[back to top]
-
-

-
 ## Contributing
 
 See [CONTRIBUTING.md in the repo](https://github.com/javanile/pipetest/blob/main/CONTRIBUTING.md), obviously pull-request are welcome.

• Running GitHub Actions for README.md ✓ Edit

Check README.md with contents:

Ran GitHub Actions for dc1e60b6a48dc1c9353a8134630a67c2b0181e38:

• Modify README.md ▶ Edit

Modify README.md with contents:
• Replace the incorrect command `assert_file_exists` with the correct command `assert_directory_exists` in the usage section and examples.
• Add a description for the `assert_directory_exists` function, similar to the other functions, explaining that it fails if the piped directory name as text does not exist.
• Provide examples for the `assert_directory_exists` function, such as: ```bash mkdir sample_dir assert_directory_exists sample_dir "Directory does not exist." ```
• Add a description and examples for the `assert_directory_not_exists` function, explaining that it fails if the piped directory name as text exists.
• Provide examples for the `assert_directory_not_exists` function, such as: ```bash rmdir sample_dir assert_directory_not_exists sample_dir "Directory still exists." ```
• These changes will fill in the missing descriptions and examples, ensuring the documentation is complete and accurate.

• Running GitHub Actions for README.md ▶ Edit

Check README.md with contents:

---

Step 3: 🔁 Code Review

Working on it...

---

🎉 Latest improvements to Sweep:

• New dashboard launched for real-time tracking of Sweep issues, covering all stages from search to coding.
• Integration of OpenAI's latest Assistant API for more efficient and reliable code planning and editing, improving speed by 3x.
• Use the GitHub issues extension for creating Sweep issues directly from your editor.

💡 To recreate the pull request edit the issue title or description.
^{Something wrong? Let us know.}

This is an automated message generated by Sweep AI.