javanile / pipetest

⛲ A minimal set of shell functions useful to implement assertions through pipe chaining. Loved by developer
MIT License
2 stars 0 forks source link

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

Open francescobianco opened 7 months ago

francescobianco commented 7 months ago

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

Checklist - [X] Modify `README.md` ✓ https://github.com/javanile/pipetest/commit/dc1e60b6a48dc1c9353a8134630a67c2b0181e38 [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L137-L220) - [X] Running GitHub Actions for `README.md` ✓ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L137-L220) - [ ] Modify `README.md` ▶ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L224-L250) - [ ] Running GitHub Actions for `README.md` ▶ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L224-L250)
francescobianco commented 7 months ago
Sweeping

50%
💎 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)


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. https://github.com/javanile/pipetest/blob/e14191928caf880629628d15f9d59c92a8db76ac/README.md#L58-L250

Step 2: ⌨️ Coding

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

Ran GitHub Actions for dc1e60b6a48dc1c9353a8134630a67c2b0181e38:


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.